commands/vpopbull.pod
changeset 2 b3afb9f1e801
parent 1 30113bfbe723
child 3 3d1d327cfa68
equal deleted inserted replaced
1:30113bfbe723 2:b3afb9f1e801
     1 =head1 NAME
       
     2 
       
     3 vpopbull - Delivers pop bulletins to virtual users
       
     4 
       
     5 =head1 SYNOPSIS
       
     6 
       
     7 B<vpopbull>
       
     8 [B<--quiet>]
       
     9 
       
    10 
       
    11 =head1 DESCRIPTION
       
    12 
       
    13 Scans bulletin directories for any which are newer than the
       
    14 F<.timestamp> file in the specified maildir.
       
    15 For each bulletin that it finds, it adds a symlink to that bulletin to
       
    16 the specified maildir.
       
    17 Since no reformatting is done, these bulletins must be fully formatted
       
    18 email messages, including full headers.
       
    19 
       
    20 This program is designed to be run from C<checkvpw-postsetuid>.
       
    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 Exits false if an error occurred during startup, true otherwise.
       
    37 
       
    38 
       
    39 
       
    40 =head1 ENVIRONMENT
       
    41 
       
    42 
       
    43 This program expects the environment variable C<HOME> to be set, and
       
    44 executes a change directory to the contents of it before starting.
       
    45 
       
    46 This program expects C<MAILDIR> to be set, and delivers any bulletins
       
    47 that it finds into this maildir.
       
    48 
       
    49 If C<VUSER> is set, a local bulletin directory is searched as above.
       
    50 
       
    51 
       
    52 
       
    53 =head1 FILES
       
    54 
       
    55 
       
    56 The following control files are used:
       
    57 
       
    58 =over 8
       
    59 
       
    60 =item F<global-bulletin-dir>
       
    61 
       
    62 This specifies the bulletin directory for all domains.
       
    63 
       
    64 =item F<bulletin-dir>
       
    65 
       
    66 This specifies the bulletin (sub)directory for virtual domains.
       
    67 
       
    68 =back
       
    69 
       
    70 
       
    71 
       
    72 =head1 SEE ALSO
       
    73 
       
    74 
       
    75 vmailmgr(7),
       
    76 checkvpw(8),
       
    77 configuration.html
       
    78 
       
    79 
       
    80 
       
    81 =head1 NOTES
       
    82 
       
    83 
       
    84 If either the global or local bulletin directories do not exist, they
       
    85 are silently ignored without failing.
       
    86 
       
    87 
       
    88 
       
    89 =head1 AUTHORS
       
    90 
       
    91 Bruce Guenter <bruceg@em.ca>
       
    92