summaryrefslogtreecommitdiffstats
path: root/proxy/man/gssproxy.8.xml
blob: 1df4b0d5bd716c302d79616e233782e12b25a879 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<reference>
<title>GssProxy Manual pages</title>
<refentry>
    <refentryinfo>
        <productname>GSS Proxy</productname>
        <orgname>GSS-Proxy - http://fedorahosted.org/gss-proxy</orgname>
    </refentryinfo>

    <refmeta>
        <refentrytitle>gssproxy</refentrytitle>
        <manvolnum>8</manvolnum>
    </refmeta>

    <refnamediv id='name'>
        <refname>gssproxy</refname>
        <refpurpose>GssProxy Daemon</refpurpose>
    </refnamediv>

    <refsynopsisdiv id='synopsis'>
        <cmdsynopsis>
            <command>gssproxy</command>
            <arg choice='opt'>
                <replaceable>options</replaceable>
            </arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1 id='description'>
        <title>DESCRIPTION</title>
        <para>
            <command>gssproxy</command> provides a daemon to manage access to
            GSSAPI credentials.
        </para>
        <para>
            <command>gssproxy</command> consists of the <command>gssproxy</command> daemon
            (configured by the <citerefentry><refentrytitle>gssproxy.conf</refentrytitle>
            <manvolnum>5</manvolnum></citerefentry> file) and a GSSAPI interposer plugin
            (<citerefentry><refentrytitle>gssproxy-mech</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>).
        </para>
    </refsect1>

    <refsect1 id='options'>
        <title>OPTIONS</title>
        <variablelist remap='IP'>
            <varlistentry>
                <term>
                    <option>-D</option>,<option>--daemon</option>
                </term>
                <listitem>
                    <para>
                        Become a daemon after starting up.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-i</option>,<option>--interactive</option>
                </term>
                <listitem>
                    <para>
                        Run in the foreground, don't become a daemon.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-c</option>,<option>--config</option>
                </term>
                <listitem>
                    <para>
                        Specify a config file to use as the main config file
                        (read before the rest of the config directory).  The
                        default is to use the file
                        <filename>/etc/gssproxy/gssproxy.conf</filename>.
                        For reference on the config file syntax and options,
                        consult the
                        <citerefentry>
                            <refentrytitle>gssproxy.conf</refentrytitle>
                            <manvolnum>5</manvolnum>
                        </citerefentry>
                        manual page.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-C</option>,<option>--configdir</option>
                </term>
                <listitem>
                    <para>
                        Specify a non-default config dir.  Files named of the
                        form "##-foo.conf" (that is, beginning with two digits
                        and a dash, and ending in ".conf") will be read in
                        numeric order from this directory, in addition to the
                        config file itself.  The default is
                        <filename>/etc/gssproxy</filename>. For reference on
                        the config file syntax and options, consult the
                        <citerefentry>
                            <refentrytitle>gssproxy.conf</refentrytitle>
                            <manvolnum>5</manvolnum>
                        </citerefentry>
                        manual page.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-s</option>,<option>--socket</option>
                </term>
                <listitem>
                    <para>
                        Specify a custom default socket name. This socket will be used
                        by all sections that do not define an explicit socket.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-d</option>,<option>--debug</option>
                </term>
                <listitem>
                    <para>
                        Turn on debugging.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>--version</option>
                </term>
                <listitem>
                    <para>
                        Print version number and exit.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

    <refsect1>
        <title>Signals</title>
        <variablelist remap='IP'>
            <varlistentry>
                <term>SIGTERM/SIGINT</term>
                <listitem>
                    <para>
                        Informs the GssProxy to gracefully terminate all of its
                        child processes and then shut down.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>SIGHUP</term>
                <listitem>
                    <para>
                        Request a reload of all configuration for gssproxy.
                        If there is an error in the configuration files, the
                        existing configuration will not be replaced; if there
                        is a problem applying the new configuration, gssproxy
                        will exit.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

    <refsect1 id='see_also'>
        <title>SEE ALSO</title>
        <para>
            <citerefentry>
                <refentrytitle>gssproxy.conf</refentrytitle><manvolnum>5</manvolnum>
            </citerefentry> and
            <citerefentry>
                <refentrytitle>gssproxy-mech</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>.
        </para>
    </refsect1>
</refentry>
</reference>