commands/vsetup.pod
changeset 0 6f7a81934006
equal deleted inserted replaced
-1:000000000000 0:6f7a81934006
       
     1 =head1 NAME
       
     2 
       
     3 vsetup - Sets up a virtual domain for its first use
       
     4 
       
     5 =head1 SYNOPSIS
       
     6 
       
     7 B<vsetup>
       
     8 [B<--quiet>]
       
     9 
       
    10 
       
    11 =head1 DESCRIPTION
       
    12 
       
    13 This program sets up the basic set of necessary files needed to use an
       
    14 account as a virtual domain with vmailmgr.
       
    15 The users directory is created if it does not exist.
       
    16 A F<.qmail-default> file is created with the proper contents.
       
    17 If a F<.qmail-default> previously existed, it is renamed to
       
    18 F<.qmail-default~>.
       
    19 Three system aliases (C<root>, C<mailer-daemon>, and C<postmaster>)
       
    20 are created to point to the configured postmaster.
       
    21 
       
    22 
       
    23 =head1 OPTIONS
       
    24 
       
    25 =over 8
       
    26 
       
    27 =item B<--quiet>
       
    28 
       
    29 Suppress all status messages.
       
    30 
       
    31 =back
       
    32 
       
    33 =head1 RETURN VALUE
       
    34 
       
    35 
       
    36 0 if all files and directories are successfully created, 1 otherwise.
       
    37 
       
    38 
       
    39 
       
    40 =head1 SEE ALSO
       
    41 
       
    42 
       
    43 vdeliver(1), vmailmgrd(8)
       
    44 
       
    45 
       
    46 
       
    47 =head1 NOTES
       
    48 
       
    49 
       
    50 This program expects the environment variable C<HOME> to be set, and
       
    51 executes a change directory to the contents of it before starting.  It
       
    52 is also required that you change user to the domain owner before using
       
    53 these utilities.
       
    54 
       
    55 
       
    56 
       
    57 =head1 AUTHORS
       
    58 
       
    59 Bruce Guenter <bruceg@em.ca>
       
    60