document davolserver
authorDerrick Brashear <shadow@dementia.org>
Fri, 16 Jul 2010 17:39:22 +0000 (13:39 -0400)
committerDerrick Brashear <shadow@dementia.org>
Sun, 18 Jul 2010 16:42:30 +0000 (09:42 -0700)
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>

doc/man-pages/pod8/.gitignore
doc/man-pages/pod8/davolserver.pod.in [new file with mode: 0644]
doc/man-pages/pod8/fragments/davolserver-synopsis.pod [new file with mode: 0644]
doc/man-pages/pod8/fragments/volserver-also.pod [new file with mode: 0644]
doc/man-pages/pod8/fragments/volserver-description.pod [new file with mode: 0644]
doc/man-pages/pod8/fragments/volserver-options.pod [new file with mode: 0644]
doc/man-pages/pod8/fragments/volserver-privilege.pod [new file with mode: 0644]
doc/man-pages/pod8/fragments/volserver-synopsis.pod [new file with mode: 0644]
doc/man-pages/pod8/volserver.pod [deleted file]
doc/man-pages/pod8/volserver.pod.in [new file with mode: 0644]

index 3c6265f..62b6743 100644 (file)
@@ -3,4 +3,6 @@
 # to check that you haven't inadvertently ignored any tracked files.
 
 /dafileserver.pod
+/davolserver.pod
 /fileserver.pod
+/volserver.pod
diff --git a/doc/man-pages/pod8/davolserver.pod.in b/doc/man-pages/pod8/davolserver.pod.in
new file mode 100644 (file)
index 0000000..ce1386e
--- /dev/null
@@ -0,0 +1,55 @@
+=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
diff --git a/doc/man-pages/pod8/fragments/davolserver-synopsis.pod b/doc/man-pages/pod8/fragments/davolserver-synopsis.pod
new file mode 100644 (file)
index 0000000..05aec87
--- /dev/null
@@ -0,0 +1,8 @@
+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>]
diff --git a/doc/man-pages/pod8/fragments/volserver-also.pod b/doc/man-pages/pod8/fragments/volserver-also.pod
new file mode 100644 (file)
index 0000000..5423a43
--- /dev/null
@@ -0,0 +1,5 @@
+L<BosConfig(5)>,
+L<VolserLog(5)>,
+L<bos_create(8)>,
+L<bos_getlog(8)>,
+L<vos(1)>
diff --git a/doc/man-pages/pod8/fragments/volserver-description.pod b/doc/man-pages/pod8/fragments/volserver-description.pod
new file mode 100644 (file)
index 0000000..e34a73f
--- /dev/null
@@ -0,0 +1,13 @@
+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.
diff --git a/doc/man-pages/pod8/fragments/volserver-options.pod b/doc/man-pages/pod8/fragments/volserver-options.pod
new file mode 100644 (file)
index 0000000..3c61666
--- /dev/null
@@ -0,0 +1,82 @@
+=over 4
+
+=item B<-d> <I<debug level>>
+
+Sets the detail level for the debugging trace written to the
+F</usr/afs/logs/VolserLog> file. Provide one of the following values, each
+of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
+and C<125>. 
+
+=item B<-log>
+
+Records in the /usr/afs/logs/VolserLog file the names of all users who
+successfully initiate a B<vos> command. The Volume Server also records any
+file removals that result from issuing the B<vos release> command with the
+B<-f> flag.
+
+=item B<-p> <I<number of processes>>
+
+Sets the number of server lightweight processes (LWPs) to run.  Provide an
+integer between C<4> and C<16>. The default is C<9>.
+
+=item B<-auditlog> <I<log path>>
+
+Turns on audit logging, and sets the path for the audit log.  The audit
+log records information about RPC calls, including the name of the RPC
+call, the host that submitted the call, the authenticated entity (user)
+that issued the call, the parameters for the call, and if the call
+succeeded or failed.
+
+=item B<-audit-interface> (file | sysvmq)
+
+Specifies what audit interface to use. Defaults to C<file>. See
+L<fileserver(8)> for an explanation of each interface.
+
+=item B<-udpsize> <I<size of socket buffer>>
+
+Sets the size of the UDP buffer in bytes, which is 64 KB by
+default. Provide a positive integer, preferably larger than the default.
+
+=item B<-jumbo>
+
+Allows the server to send and receive jumbograms. A jumbogram is
+a large-size packet composed of 2 to 4 normal Rx data packets that share
+the same header. The volserver does not use jumbograms by default, as some
+routers are not capable of properly breaking the jumbogram into smaller
+packets and reassembling them.
+
+=item B<-nojumbo>
+
+Deprecated; jumbograms are disabled by default.
+
+=item B<-enable_peer_stats>
+
+Activates the collection of Rx statistics and allocates memory for their
+storage. For each connection with a specific UDP port on another machine,
+a separate record is kept for each type of RPC (FetchFile, GetStatus, and
+so on) sent or received. To display or otherwise access the records, use
+the Rx Monitoring API.
+
+=item B<-enable_process_stats>
+
+Activates the collection of Rx statistics and allocates memory for their
+storage. A separate record is kept for each type of RPC (FetchFile,
+GetStatus, and so on) sent or received, aggregated over all connections to
+other machines. To display or otherwise access the records, use the Rx
+Monitoring API.
+
+=item B<-allow-dotted-principals>
+
+By default, the RXKAD security layer will disallow access by Kerberos
+principals with a dot in the first component of their name. This is to avoid
+the confusion where principals user/admin and user.admin are both mapped to the
+user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
+between principal names may disable this check by starting the server
+with this option.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
diff --git a/doc/man-pages/pod8/fragments/volserver-privilege.pod b/doc/man-pages/pod8/fragments/volserver-privilege.pod
new file mode 100644 (file)
index 0000000..0f08a8d
--- /dev/null
@@ -0,0 +1,4 @@
+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.
diff --git a/doc/man-pages/pod8/fragments/volserver-synopsis.pod b/doc/man-pages/pod8/fragments/volserver-synopsis.pod
new file mode 100644 (file)
index 0000000..03ca28a
--- /dev/null
@@ -0,0 +1,8 @@
+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>]
diff --git a/doc/man-pages/pod8/volserver.pod b/doc/man-pages/pod8/volserver.pod
deleted file mode 100644 (file)
index 535fa32..0000000
+++ /dev/null
@@ -1,161 +0,0 @@
-=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>>
-
-Sets the detail level for the debugging trace written to the
-F</usr/afs/logs/VolserLog> file. Provide one of the following values, each
-of which produces an increasingly detailed trace: C<0>, C<1>, C<5>, C<25>,
-and C<125>. 
-
-=item B<-log>
-
-Records in the /usr/afs/logs/VolserLog file the names of all users who
-successfully initiate a B<vos> command. The Volume Server also records any
-file removals that result from issuing the B<vos release> command with the
-B<-f> flag.
-
-=item B<-p> <I<number of processes>>
-
-Sets the number of server lightweight processes (LWPs) to run.  Provide an
-integer between C<4> and C<16>. The default is C<9>.
-
-=item B<-auditlog> <I<log path>>
-
-Turns on audit logging, and sets the path for the audit log.  The audit
-log records information about RPC calls, including the name of the RPC
-call, the host that submitted the call, the authenticated entity (user)
-that issued the call, the parameters for the call, and if the call
-succeeded or failed.
-
-=item B<-audit-interface> (file | sysvmq)
-
-Specifies what audit interface to use. Defaults to C<file>. See
-L<fileserver(8)> for an explanation of each interface.
-
-=item B<-udpsize> <I<size of socket buffer>>
-
-Sets the size of the UDP buffer in bytes, which is 64 KB by
-default. Provide a positive integer, preferably larger than the default.
-
-=item B<-jumbo>
-
-Allows the server to send and receive jumbograms. A jumbogram is
-a large-size packet composed of 2 to 4 normal Rx data packets that share
-the same header. The volserver does not use jumbograms by default, as some
-routers are not capable of properly breaking the jumbogram into smaller
-packets and reassembling them.
-
-=item B<-nojumbo>
-
-Deprecated; jumbograms are disabled by default.
-
-=item B<-enable_peer_stats>
-
-Activates the collection of Rx statistics and allocates memory for their
-storage. For each connection with a specific UDP port on another machine,
-a separate record is kept for each type of RPC (FetchFile, GetStatus, and
-so on) sent or received. To display or otherwise access the records, use
-the Rx Monitoring API.
-
-=item B<-enable_process_stats>
-
-Activates the collection of Rx statistics and allocates memory for their
-storage. A separate record is kept for each type of RPC (FetchFile,
-GetStatus, and so on) sent or received, aggregated over all connections to
-other machines. To display or otherwise access the records, use the Rx
-Monitoring API.
-
-=item B<-allow-dotted-principals>
-
-By default, the RXKAD security layer will disallow access by Kerberos
-principals with a dot in the first component of their name. This is to avoid
-the confusion where principals user/admin and user.admin are both mapped to the
-user.admin PTS entry. Sites whose Kerberos realms don't have these collisions 
-between principal names may disable this check by starting the server
-with this option.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-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.
diff --git a/doc/man-pages/pod8/volserver.pod.in b/doc/man-pages/pod8/volserver.pod.in
new file mode 100644 (file)
index 0000000..aeca0dc
--- /dev/null
@@ -0,0 +1,53 @@
+=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