split davolserver and volserver documentation.
refer both ways between docs.
Change-Id: Iac70ac8e1fb8bfcb7ebfdbed8e9d7870a2e69fee
Reviewed-on: http://gerrit.openafs.org/2441
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
# to check that you haven't inadvertently ignored any tracked files.
/dafileserver.pod
+/davolserver.pod
/fileserver.pod
+/volserver.pod
--- /dev/null
+=head1 NAME
+
+davolserver - Initializes the Volume Server component of the dafs process
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+=include fragments/volserver-synopsis.pod
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<davolserver> command initializes the Volume Server component of the
+C<dafs> process. In the conventional configuration, its binary file is
+located in the F</usr/afs/bin> directory on a file server machine.
+
+The B<davolserver> command is not normally issued at the command shell
+prompt but rather placed into a file server machine's
+F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
+ever issued at the command shell prompt, the issuer must be logged onto a
+database server machine as the local superuser C<root>.
+
+=include fragments/volserver-description.pod
+
+=head1 OPTIONS
+
+=include fragments/volserver-options.pod
+
+=head1 EXAMPLES
+
+The following B<bos create> command creates a C<davolserver> process on the
+machine C<fs2.abc.com> as part of the dafs process:
+
+ % bos create -server fs2.abc.com -instance dafs -type dafs \
+ -cmd "/usr/afs/bin/dafileserver" \
+ /usr/afs/bin/davolserver \
+ /usr/afs/bin/salvageserver \
+ /usr/afs/bin/dasalvager
+
+=head1 PRIVILEGE REQUIRED
+
+=include fragments/volserver-privilege.pod
+
+=head1 SEE ALSO
+
+=include fragments/volserver-also.pod
+L<volserver(8)>,
+
+=head1 COPYRIGHT
+
+=include fragments/fileserver-copyright.pod
--- /dev/null
+B<davolserver>
+ [B<-log>] S<<< [B<-p> <I<number of processes>>] >>>
+ S<<< [B<-auditlog> <I<log path>>] >>> [B<-audit-interface> (file | sysvmq)]
+ S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
+ S<<< [B<-d> <I<debug level>>] >>>
+ [B<-nojumbo>] [B<-jumbo>]
+ [B<-enable_peer_stats>] [B<-enable_process_stats>]
+ [B<-allow-dotted-principals>] [B<-help>]
--- /dev/null
+L<BosConfig(5)>,
+L<VolserLog(5)>,
+L<bos_create(8)>,
+L<bos_getlog(8)>,
+L<vos(1)>
--- /dev/null
+The Volume Server records a trace of its activity in the
+F</usr/afs/logs/VolserLog> file. Use the B<bos getlog> command to display
+the contents of the file.
+
+The Volume Server processes the B<vos> commands that administrators use to
+create, delete, move, and replicate volumes, as well as prepare them for
+archiving to tape or other media.
+
+By default, the VL Server runs nine lightweight processes (LWPs). To
+change the number, use the B<-p> argument.
+
+This command does not use the syntax conventions of the AFS command
+suites. Provide the command name and all option names in full.
-=head1 NAME
-
-volserver - Initializes the Volume Server component of the fs process
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<volserver> [B<-log>] S<<< [B<-p> <I<number of processes>>] >>>
- S<<< [B<-auditlog> <I<log path>>] >>> [B<-audit-interface> (file | sysvmq)]
- S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
- S<<< [B<-d> <I<debug level>>] >>>
- [B<-nojumbo>] [B<-jumbo>]
- [B<-enable_peer_stats>] [B<-enable_process_stats>]
- [B<-allow-dotted-principals>] [B<-help>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<volserver> command initializes the Volume Server component of the
-C<fs> process. In the conventional configuration, its binary file is
-located in the F</usr/afs/bin> directory on a file server machine.
-
-The B<volserver> command is not normally issued at the command shell
-prompt but rather placed into a file server machine's
-F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
-ever issued at the command shell prompt, the issuer must be logged onto a
-database server machine as the local superuser C<root>.
-
-The Volume Server records a trace of its activity in the
-F</usr/afs/logs/VolserLog> file. Use the B<bos getlog> command to display
-the contents of the file.
-
-The Volume Server processes the B<vos> commands that administrators use to
-create, delete, move, and replicate volumes, as well as prepare them for
-archiving to tape or other media.
-
-By default, the VL Server runs nine lightweight processes (LWPs). To
-change the number, use the B<-p> argument.
-
-This command does not use the syntax conventions of the AFS command
-suites. Provide the command name and all option names in full.
-
-=head1 OPTIONS
-
=over 4
=item B<-d> <I<debug level>>
ignored.
=back
-
-=head1 EXAMPLES
-
-The following B<bos create> command creates a C<volserver> process on the
-machine C<fs2.abc.com>:
-
- % bos create -server fs2.abc.com -instance volserver -type simple \
- -cmd /usr/afs/bin/volserver
-
-=head1 PRIVILEGE REQUIRED
-
-The issuer must be logged in as the superuser C<root> on a file server
-machine to issue the command at a command shell prompt. It is conventional
-instead to create and start the process by issuing the B<bos create>
-command.
-
-=head1 SEE ALSO
-
-L<BosConfig(5)>,
-L<VolserLog(5)>,
-L<bos_create(8)>,
-L<bos_getlog(8)>,
-L<vos(1)>
-
-=head1 COPYRIGHT
-
-IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
-
-This documentation is covered by the IBM Public License Version 1.0. It was
-converted from HTML to POD by software written by Chas Williams and Russ
-Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
--- /dev/null
+The issuer must be logged in as the superuser C<root> on a file server
+machine to issue the command at a command shell prompt. It is conventional
+instead to create and start the process by issuing the B<bos create>
+command.
--- /dev/null
+B<volserver>
+ [B<-log>] S<<< [B<-p> <I<number of processes>>] >>>
+ S<<< [B<-auditlog> <I<log path>>] >>> [B<-audit-interface> (file | sysvmq)]
+ S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
+ S<<< [B<-d> <I<debug level>>] >>>
+ [B<-nojumbo>] [B<-jumbo>]
+ [B<-enable_peer_stats>] [B<-enable_process_stats>]
+ [B<-allow-dotted-principals>] [B<-help>]
--- /dev/null
+=head1 NAME
+
+volserver - Initializes the Volume Server component of the fs process
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+=include fragments/volserver-synopsis.pod
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<volserver> command initializes the Volume Server component of the
+C<fs> process. In the conventional configuration, its binary file is
+located in the F</usr/afs/bin> directory on a file server machine.
+
+The B<volserver> command is not normally issued at the command shell
+prompt but rather placed into a file server machine's
+F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
+ever issued at the command shell prompt, the issuer must be logged onto a
+database server machine as the local superuser C<root>.
+
+=include fragments/volserver-description.pod
+
+=head1 OPTIONS
+
+=include fragments/volserver-options.pod
+
+=head1 EXAMPLES
+
+The following B<bos create> command creates a C<volserver> process on the
+machine C<fs2.abc.com> as part of the fs process:
+
+ % bos create -server fs2.abc.com -instance fs -type fs \
+ -cmd "/usr/afs/bin/fileserver" \
+ /usr/afs/bin/volserver /usr/afs/bin/salvager
+
+=head1 PRIVILEGE REQUIRED
+
+=include fragments/volserver-privilege.pod
+
+=head1 SEE ALSO
+
+=include fragments/volserver-also.pod
+L<davolserver(8)>,
+
+=head1 COPYRIGHT
+
+=include fragments/fileserver-copyright.pod
git://git.openafs.org / openafs.git / commitdiff