From 9ce7949b9f016ce9382cea51359dfd852df1d4f3 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sun, 9 Sep 2012 14:52:13 +0200 Subject: Sort manpage manually --- fripost | 255 ++++++++++++++++++++++++++++++++-------------------------------- 1 file changed, 128 insertions(+), 127 deletions(-) (limited to 'fripost') diff --git a/fripost b/fripost index 7510643..e0f7dd8 100755 --- a/fripost +++ b/fripost @@ -13,8 +13,8 @@ fripost - Fripost.org handling utility for virtual hosting =head1 SYNOPSIS -B [I] { mkpass | add-user | search-user | user-passwd -| add-domain | search-domain | add-alias | search-alias } +B [I] { add-alias | add-domain | add-user | mkpass | +search-alias | search-domain | search-user | user-passwd } B B<--man> @@ -22,38 +22,38 @@ B B<--man> =over 4 -=item B mkpass [I] - -Create a random new password, and returns its hash. - -=item B add-user [I] [B<--password=>I] +=item B add-alias [B<--force>] [I [I...]] -Add a new virtual mailbox. +Add a new virtual alias. -=item B search-user [I] +=item B add-domain [B<--force>] [I [I]] -List matching virtual users. +Add a new virtual domain. -=item B user-passwd [I] [B<--password=>I] +=item B add-user [I] [B<--password=>I] -Change user password. +Add a new virtual mailbox. -=item B add-domain [B<--force>] [I [I]] +=item B mkpass [I] -Add a new virtual domain. +Create a random new password, and returns its hash. =item B search-domain [I [I]] List matching virtual domains. -=item B add-alias [B<--force>] [I [I...]] +=item B search-user [I] -Add a new virtual alias. +List matching virtual users. =item B search-alias [B<-f>|B<--from>] [B<-g>|B<--goto>] [I
] List matching virtual aliases. +=item B user-passwd [I] [B<--password=>I] + +Change user password. + =back =head1 DESCRIPTION @@ -63,77 +63,6 @@ the following commands is required. =over 4 -=item B mkpass [I] - -C is used to generate a salted SHA-1 hash of the given -I. If no argument is given, the password is randomly -generated, respecting Fripost's password policy. - -=item B add-user [I] [B<--password=>I] - -C is used to add a new virtual mailbox to the system, unless -B<--pretend> is set. -If I or I are not given, the user is prompted for -their value. -If I is not fully qualified, the domain C is -appended. -An error is raised if I is already an existing virtual user or -alias. -If I is given, is it used RAW (not hashed). -This can be useful if the user does not want to give the clear copy but -only a hash, for example. -Using this option disables the sending of credentials. - -=item B search-user [I] - -C is used to -list virtual mailboxes whose username matches exactly I. -Wildcards I<*> can appear in I, to match zero or more characters. -If no I is given, lists all existing mailboxes. - -If I has no domain part, C lists matching users for any -domains. -Otherwise, C looks up the matching user parts for each matching -domain. -Because of these multiple searches, the use of wildcards on the domain -part of I may be inefficient. - -=item B user-passwd [I] [B<--password=>I] - -C is used to change the password of I, unless -B<--pretend> is set. -If I or I are not given, the user is prompted for -their value. -If I is not fully qualified, the domain C is appended. -An error is raised if I is not an existing virtual user. -If I is given, is it used RAW (not hashed). -This can be useful if the user does not want to give the clear copy but -only a hash, for example. -Using this option disables the sending of credentials. - -=item B add-domain [B<--force>] [I [I]] - -C is used add a new virtual domain to the system, unless -B<--pretend> is set. -If I is not given, the user is prompted for its value. -By default, C prompts for the owner(s) of the new -domain; Use the empty string I<''> in the command line to create a -"global" domain, only managed by Fripost's administrators. -An error is raised if I is an existing virtual domain unless -B<--force> is set, in which case -I is simply added to the list of managers. - -=item B search-domain [I [I]] - -C is used to list virtual domains matching exactly I, -and whose owner is I. -Wildcards I<*> can appear in I, to match zero or more characters. -If no I is given, list all domains matching I, regardless -of the owner; If I is the empty string I<''>, list only the non -self-managed domains. -If neither I nor I are given, C lists -all existing virtual domains. - =item B add-alias [B<--force>] [I [I...]] C is used to add a new virtual alias to the system, unless @@ -170,6 +99,39 @@ I, emails to I@I will be redirected to BOTH I and I. Note that C forbids the creation of such multi-recipient aliases, unless B<--force> is set. +=item B add-domain [B<--force>] [I [I]] + +C is used add a new virtual domain to the system, unless +B<--pretend> is set. +If I is not given, the user is prompted for its value. +By default, C prompts for the owner(s) of the new +domain; Use the empty string I<''> in the command line to create a +"global" domain, only managed by Fripost's administrators. +An error is raised if I is an existing virtual domain unless +B<--force> is set, in which case +I is simply added to the list of managers. + +=item B add-user [I] [B<--password=>I] + +C is used to add a new virtual mailbox to the system, unless +B<--pretend> is set. +If I or I are not given, the user is prompted for +their value. +If I is not fully qualified, the domain C is +appended. +An error is raised if I is already an existing virtual user or +alias. +If I is given, is it used RAW (not hashed). +This can be useful if the user does not want to give the clear copy but +only a hash, for example. +Using this option disables the sending of credentials. + +=item B mkpass [I] + +C is used to generate a salted SHA-1 hash of the given +I. If no argument is given, the password is randomly +generated, respecting Fripost's password policy. + =item B search-alias [B<-f>|B<--from>] [B<-g>|B<--goto>] [I
] C is used to list virtual aliases whose value or target @@ -181,21 +143,53 @@ To list matching aliases (resp., targets) only, use the flag B<-f> If no I
is given, C lists all existing virtual aliases. +=item B search-domain [I [I]] + +C is used to list virtual domains matching exactly I, +and whose owner is I. +Wildcards I<*> can appear in I, to match zero or more characters. +If no I is given, list all domains matching I, regardless +of the owner; If I is the empty string I<''>, list only the non +self-managed domains. +If neither I nor I are given, C lists +all existing virtual domains. + +=item B search-user [I] + +C is used to +list virtual mailboxes whose username matches exactly I. +Wildcards I<*> can appear in I, to match zero or more characters. +If no I is given, lists all existing mailboxes. + +If I has no domain part, C lists matching users for any +domains. +Otherwise, C looks up the matching user parts for each matching +domain. +Because of these multiple searches, the use of wildcards on the domain +part of I may be inefficient. + +=item B user-passwd [I] [B<--password=>I] + +C is used to change the password of I, unless +B<--pretend> is set. +If I or I are not given, the user is prompted for +their value. +If I is not fully qualified, the domain C is appended. +An error is raised if I is not an existing virtual user. +If I is given, is it used RAW (not hashed). +This can be useful if the user does not want to give the clear copy but +only a hash, for example. +Using this option disables the sending of credentials. + =back =head1 OPTIONS =over 8 -=item B<--pretend> - -Dry-run all operations that is, do not modify the virtual lookup tables. -But still queries the LDAP server to ensure that the modification would -be safe. (For instance, ensure that a new user is not already existing.) - -=item B<--server_host=>I +=item B<--base_dn=>I -The LDAP URI to connect to. +The root DN for every communication to the LDAP server. Overrides the value read from the configuration file (see B) if present. @@ -212,20 +206,9 @@ The password to to bind with. Overrides the value read from the configuration file (see B) if present. -=item B<--base_dn=>I - -The root DN for every communication to the LDAP server. -Overrides the value read from the configuration file (see -B) if present. - -=item B<--sign>[B<=>I] +=item B<-d>, B<--debug> -Use I as the key to sign all non-empty emails. If I is empty -or not given, use the first key found in the secret keyring, see -B(1). A running gpg-agent is required if the private key is -protected by a passphrase. -Overrides the value read from the configuration file (see -B) if present. +Debug mode. =item B{I|I|I} @@ -243,13 +226,31 @@ B) if present. If one of the I or I encryption level is chosen, encrypt for the user ID I. -=item B<-v>, B<--verbose> +=item B<--pretend> -Verbose mode. +Dry-run all operations that is, do not modify the virtual lookup tables. +But still queries the LDAP server to ensure that the modification would +be safe. (For instance, ensure that a new user is not already existing.) -=item B<-d>, B<--debug> -Debug mode. +=item B<--server_host=>I + +The LDAP URI to connect to. +Overrides the value read from the configuration file (see +B) if present. + +=item B<--sign>[B<=>I] + +Use I as the key to sign all non-empty emails. If I is empty +or not given, use the first key found in the secret keyring, see +B(1). A running gpg-agent is required if the private key is +protected by a passphrase. +Overrides the value read from the configuration file (see +B) if present. + +=item B<-v>, B<--verbose> + +Verbose mode. =back @@ -261,14 +262,14 @@ Valid keys include: =over 4 -=item I - -The LDAP URI to connect to. Defaults to C. - =item I The I e-mail address to use. Defaults to C. +=item I + +The root DN for every communication to the LDAP server. + =item I The Distinguished Name (DN) to bind to the LDAP directory. @@ -278,17 +279,6 @@ The Distinguished Name (DN) to bind to the LDAP directory. The password to to bind with. -=item I - -The root DN for every communication to the LDAP server. - -=item I - -The key used to sign all non-empty emails. If no key is given, -use the first one found in the secret keyring, see B(1). -A running gpg-agent is required if the private key is -protected by a passphrase. - =item I Tells whether non-empty emails should be encrypted. @@ -299,6 +289,17 @@ keyring. I will disallow the sending of all non-empty clear emails (not recommended). +=item I + +The LDAP URI to connect to. Defaults to C. + +=item I + +The key used to sign all non-empty emails. If no key is given, +use the first one found in the secret keyring, see B(1). +A running gpg-agent is required if the private key is +protected by a passphrase. + =back =cut -- cgit v1.2.3