/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 07:32:05 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831073205-9hggg03i1iird264
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
* mandos.xml (SYNOPSIS): - '' -
* plugins.d/password-prompt.xml (SYNOPSIS): - '' -
* plugins.d/password-request.xml (SYNOPSIS): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos-keygen">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
6
7
]>
7
8
 
8
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
10
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
    <title>Mandos Manual</title>
11
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
 
13
    <productname>Mandos</productname>
13
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
14
16
    <authorgroup>
15
17
      <author>
16
18
        <firstname>Björn</firstname>
73
75
  <refsynopsisdiv>
74
76
    <cmdsynopsis>
75
77
      <command>&COMMANDNAME;</command>
76
 
      <group choice="opt">
77
 
        <arg choice="plain"><option>--dir</option>
78
 
        <replaceable>directory</replaceable></arg>
79
 
      </group>
80
 
      <group choice="opt">
81
 
        <arg choice="plain"><option>--type</option>
82
 
        <replaceable>type</replaceable></arg>
83
 
      </group>
84
 
      <group choice="opt">
85
 
        <arg choice="plain"><option>--length</option>
86
 
        <replaceable>bits</replaceable></arg>
87
 
      </group>
88
 
      <group choice="opt">
89
 
        <arg choice="plain"><option>--subtype</option>
90
 
        <replaceable>type</replaceable></arg>
91
 
      </group>
92
 
      <group choice="opt">
93
 
        <arg choice="plain"><option>--sublength</option>
94
 
        <replaceable>bits</replaceable></arg>
95
 
      </group>
96
 
      <group choice="opt">
97
 
        <arg choice="plain"><option>--name</option>
98
 
        <replaceable>NAME</replaceable></arg>
99
 
      </group>
100
 
      <group choice="opt">
101
 
        <arg choice="plain"><option>--email</option>
102
 
        <replaceable>EMAIL</replaceable></arg>
103
 
      </group>
104
 
      <group choice="opt">
105
 
        <arg choice="plain"><option>--comment</option>
106
 
        <replaceable>COMMENT</replaceable></arg>
107
 
      </group>
108
 
      <group choice="opt">
109
 
        <arg choice="plain"><option>--expire</option>
110
 
        <replaceable>TIME</replaceable></arg>
111
 
      </group>
112
 
      <group choice="opt">
113
 
        <arg choice="plain"><option>--force</option></arg>
114
 
      </group>
115
 
    </cmdsynopsis>
116
 
    <cmdsynopsis>
117
 
      <command>&COMMANDNAME;</command>
118
 
      <group choice="opt">
119
 
        <arg choice="plain"><option>-d</option>
120
 
        <replaceable>directory</replaceable></arg>
121
 
      </group>
122
 
      <group choice="opt">
123
 
        <arg choice="plain"><option>-t</option>
124
 
        <replaceable>type</replaceable></arg>
125
 
      </group>
126
 
      <group choice="opt">
127
 
        <arg choice="plain"><option>-l</option>
128
 
        <replaceable>bits</replaceable></arg>
129
 
      </group>
130
 
      <group choice="opt">
131
 
        <arg choice="plain"><option>-s</option>
132
 
        <replaceable>type</replaceable></arg>
133
 
      </group>
134
 
      <group choice="opt">
135
 
        <arg choice="plain"><option>-L</option>
136
 
        <replaceable>bits</replaceable></arg>
137
 
      </group>
138
 
      <group choice="opt">
139
 
        <arg choice="plain"><option>-n</option>
140
 
        <replaceable>NAME</replaceable></arg>
141
 
      </group>
142
 
      <group choice="opt">
143
 
        <arg choice="plain"><option>-e</option>
144
 
        <replaceable>EMAIL</replaceable></arg>
145
 
      </group>
146
 
      <group choice="opt">
147
 
        <arg choice="plain"><option>-c</option>
148
 
        <replaceable>COMMENT</replaceable></arg>
149
 
      </group>
150
 
      <group choice="opt">
151
 
        <arg choice="plain"><option>-x</option>
152
 
        <replaceable>TIME</replaceable></arg>
153
 
      </group>
154
 
      <group choice="opt">
155
 
        <arg choice="plain"><option>-f</option></arg>
156
 
      </group>
 
78
      <group>
 
79
        <arg choice="plain"><option>--dir
 
80
        <replaceable>DIRECTORY</replaceable></option></arg>
 
81
        <arg choice="plain"><option>-d
 
82
        <replaceable>DIRECTORY</replaceable></option></arg>
 
83
      </group>
 
84
      <sbr/>
 
85
      <group>
 
86
        <arg choice="plain"><option>--type
 
87
        <replaceable>KEYTYPE</replaceable></option></arg>
 
88
        <arg choice="plain"><option>-t
 
89
        <replaceable>KEYTYPE</replaceable></option></arg>
 
90
      </group>
 
91
      <sbr/>
 
92
      <group>
 
93
        <arg choice="plain"><option>--length
 
94
        <replaceable>BITS</replaceable></option></arg>
 
95
        <arg choice="plain"><option>-l
 
96
        <replaceable>BITS</replaceable></option></arg>
 
97
      </group>
 
98
      <sbr/>
 
99
      <group>
 
100
        <arg choice="plain"><option>--subtype
 
101
        <replaceable>KEYTYPE</replaceable></option></arg>
 
102
        <arg choice="plain"><option>-s
 
103
        <replaceable>KEYTYPE</replaceable></option></arg>
 
104
      </group>
 
105
      <sbr/>
 
106
      <group>
 
107
        <arg choice="plain"><option>--sublength
 
108
        <replaceable>BITS</replaceable></option></arg>
 
109
        <arg choice="plain"><option>-L
 
110
        <replaceable>BITS</replaceable></option></arg>
 
111
      </group>
 
112
      <sbr/>
 
113
      <group>
 
114
        <arg choice="plain"><option>--name
 
115
        <replaceable>NAME</replaceable></option></arg>
 
116
        <arg choice="plain"><option>-n
 
117
        <replaceable>NAME</replaceable></option></arg>
 
118
      </group>
 
119
      <sbr/>
 
120
      <group>
 
121
        <arg choice="plain"><option>--email
 
122
        <replaceable>ADDRESS</replaceable></option></arg>
 
123
        <arg choice="plain"><option>-e
 
124
        <replaceable>ADDRESS</replaceable></option></arg>
 
125
      </group>
 
126
      <sbr/>
 
127
      <group>
 
128
        <arg choice="plain"><option>--comment
 
129
        <replaceable>TEXT</replaceable></option></arg>
 
130
        <arg choice="plain"><option>-c
 
131
        <replaceable>TEXT</replaceable></option></arg>
 
132
      </group>
 
133
      <sbr/>
 
134
      <group>
 
135
        <arg choice="plain"><option>--expire
 
136
        <replaceable>TIME</replaceable></option></arg>
 
137
        <arg choice="plain"><option>-x
 
138
        <replaceable>TIME</replaceable></option></arg>
 
139
      </group>
 
140
      <sbr/>
 
141
      <arg><option>--force</option></arg>
157
142
    </cmdsynopsis>
158
143
    <cmdsynopsis>
159
144
      <command>&COMMANDNAME;</command>
160
145
      <group choice="req">
 
146
        <arg choice="plain"><option>--password</option></arg>
161
147
        <arg choice="plain"><option>-p</option></arg>
162
 
        <arg choice="plain"><option>--password</option></arg>
163
 
      </group>
164
 
      <group choice="opt">
165
 
        <arg choice="plain"><option>--dir</option>
166
 
        <replaceable>directory</replaceable></arg>
167
 
      </group>
168
 
      <group choice="opt">
169
 
        <arg choice="plain"><option>--name</option>
170
 
        <replaceable>NAME</replaceable></arg>
 
148
      </group>
 
149
      <sbr/>
 
150
      <group>
 
151
        <arg choice="plain"><option>--dir
 
152
        <replaceable>DIRECTORY</replaceable></option></arg>
 
153
        <arg choice="plain"><option>-d
 
154
        <replaceable>DIRECTORY</replaceable></option></arg>
 
155
      </group>
 
156
      <sbr/>
 
157
      <group>
 
158
        <arg choice="plain"><option>--name
 
159
        <replaceable>NAME</replaceable></option></arg>
 
160
        <arg choice="plain"><option>-n
 
161
        <replaceable>NAME</replaceable></option></arg>
171
162
      </group>
172
163
    </cmdsynopsis>
173
164
    <cmdsynopsis>
174
165
      <command>&COMMANDNAME;</command>
175
166
      <group choice="req">
 
167
        <arg choice="plain"><option>--help</option></arg>
176
168
        <arg choice="plain"><option>-h</option></arg>
177
 
        <arg choice="plain"><option>--help</option></arg>
178
169
      </group>
179
170
    </cmdsynopsis>
180
171
    <cmdsynopsis>
181
172
      <command>&COMMANDNAME;</command>
182
173
      <group choice="req">
 
174
        <arg choice="plain"><option>--version</option></arg>
183
175
        <arg choice="plain"><option>-v</option></arg>
184
 
        <arg choice="plain"><option>--version</option></arg>
185
176
      </group>
186
177
    </cmdsynopsis>
187
178
  </refsynopsisdiv>
365
356
    <title>ENVIRONMENT</title>
366
357
    <variablelist>
367
358
      <varlistentry>
368
 
        <term><varname>TMPDIR</varname></term>
 
359
        <term><envar>TMPDIR</envar></term>
369
360
        <listitem>
370
361
          <para>
371
362
            If set, temporary files will be created here. See
429
420
        Normal invocation needs no options:
430
421
      </para>
431
422
      <para>
432
 
        <userinput>mandos-keygen</userinput>
 
423
        <userinput>&COMMANDNAME;</userinput>
433
424
      </para>
434
425
    </informalexample>
435
426
    <informalexample>
440
431
      <para>
441
432
 
442
433
<!-- do not wrap this line -->
443
 
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
 
434
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
444
435
 
445
436
      </para>
446
437
    </informalexample>
464
455
  <refsect1 id="see_also">
465
456
    <title>SEE ALSO</title>
466
457
    <para>
467
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
468
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
458
      <citerefentry><refentrytitle>gpg</refentrytitle>
 
459
      <manvolnum>1</manvolnum></citerefentry>,
469
460
      <citerefentry><refentrytitle>mandos</refentrytitle>
470
461
      <manvolnum>8</manvolnum></citerefentry>,
471
 
      <citerefentry><refentrytitle>gpg</refentrytitle>
472
 
      <manvolnum>1</manvolnum></citerefentry>
 
462
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
463
      <manvolnum>8mandos</manvolnum></citerefentry>
473
464
    </para>
474
465
  </refsect1>
475
466
  
476
467
</refentry>
 
468
<!-- Local Variables: -->
 
469
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
470
<!-- time-stamp-end: "[\"']>" -->
 
471
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
472
<!-- End: -->