don't just report the deficiency again, but any contributions towards
fixing it are greatly appreciated.
- * The section five and section eight man pages have not yet had an
- initial editing pass and many of the section five man pages are
- missing because the original reference page names didn't easily
- convert to man page names. This is currently being fixed. Please do
- not start working on the section five or section eight man pages yet
- or bother reporting problems with them; they will be changing
- significantly in the near future.
-
- * The following commands have no man pages:
+ * The following installed commands have no man pages:
+ bos_util
+ copyauth
fs getcalleraccess
fs getcrypt
fs listaliases
fs rxstatproc
fs setcbaddr
fs setcrypt
+ kseal
pts interactive
pts quit
pts sleep
pts source
+ read_tape
+ restorevol
+ rmtsysd
+ vldb_convert
vos changeloc
vos clone
vos convertROtoRW
vos copy
vos shadow
vos size
+ vsys
+
+ * The following configuration files have no man pages:
+
+ CellAlias
* klog.krb, pagsh.krb, and tokens.krb need to be listed as alternative
names in the NAME line of the non-.krb man pages, links should be
* The CellServDB documentation hasn't been updated for -dynroot.
+ * The aklog man page isn't in POD. (Neither is the mpp man page, but
+ I don't think we care about it and it's not currently installed.)
+
If you notice other problems, please send them to the openafs-doc list
even if you don't have time to fix them. Someone else might, and we
want to track all of the issues.
--- /dev/null
+=head1 NAME
+
+livesys - Reports the configured CPU/operating system type
+
+=head1 SYNOPSIS
+
+B<livesys>
+
+=head1 DESCRIPTION
+
+The B<livesys> command displays the string stored in kernel memory that
+indicates the local machine's CPU/operating system (OS) type,
+conventionally called the I<sysname>. The Cache Manager substitutes this
+string for the I<@sys> variable which can occur in AFS pathnames; the
+I<IBM AFS Quick Beginnings> and I<IBM AFS Administration Guide> explain
+how using I<@sys> can simplify cell configuration.
+
+To set a new value in kernel memory, use the B<fs sysname> command, which
+can also be used to view the current value. If a sysname list was set
+using B<fs sysname>, only the first value in the list will be reported by
+B<livesys>.
+
+=head1 CAUTIONS
+
+To see the full sysname list, use B<fs sysname> rather than this command.
+B<livesys> is mostly useful for scripts that need to know the primary
+sysname for the local system (to create directories that will later be
+addressed using I<@sys>, for example).
+
+B<livesys> first appeared in OpenAFS 1.2.2. Scripts that need to support
+older versions of AFS should parse the output of B<fs sysname> or use
+B<sys>.
+
+=head1 OUTPUT
+
+The machine's system type appears as a text string:
+
+ I<system_type>
+
+=head1 EXAMPLES
+
+The following example shows the output produced on a Linux system with a
+2.6 kernel:
+
+ % livesys
+ i386_linux26
+
+=head1 PRIVILEGE REQUIRED
+
+None
+
+=head1 SEE ALSO
+
+L<fs_sysname(1)>,
+L<sys(1)>
+
+I<IBM AFS Quick Beginnings>
+
+I<IBM AFS Administration Guide>
+
+=head1 COPYRIGHT
+
+IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
+
+Copyright 2005 Russ Allbery <rra@stanford.edu>
+
+This documentation is covered by the IBM Public License Version 1.0. It
+was written by Russ Allbery based on the B<sys> man page.
=head1 NAME
-sys - Reports the CPU/operating system type
+sys - Reports the compile-time CPU/operating system type
=head1 SYNOPSIS
-sys
+B<sys>
=head1 DESCRIPTION
-The B<sys> command displays the string stored in kernel memory that
-indicates the local machine's CPU/operating system (OS) type. The Cache
-Manager substitutes the string for the I<@sys> variable which can occur in
-AFS pathnames; the I<IBM AFS Quick Beginnings> and I<IBM AFS
-Administration Guide> explain how using I<@sys> can simplify cell
-configuration.
-
-The command always reports the value for the local machine only. To set a
-new value in kernel memory, use the B<fs sysname> command, which like this
-command can also be used to display the current value.
+The B<sys> command displays the string set at compile time that indicates
+the local machine's CPU/operating system (OS) type, conventionally called
+the I<sysname>. This string is the default for the value stored in kernel
+memory. The Cache Manager substitutes this string for the I<@sys>
+variable which can occur in AFS pathnames; the I<IBM AFS Quick Beginnings>
+and I<IBM AFS Administration Guide> explain how using I<@sys> can simplify
+cell configuration.
+
+To set a new value in kernel memory, use the B<fs sysname> command. To
+view the current value set in the kernel, use either B<fs sysname> or
+B<livesys>.
+
+=head1 CAUTIONS
+
+You almost always want to use B<livesys> rather than this command. The
+B<sys> command displays a single value hard-coded at compile time. It
+does not query the Cache Manager for the current value and it does not
+report sysname lists. If you have changed the local system type with B<fs
+sysname>, or if you run a version of B<sys> compiled differently than the
+Cache Manager running on the system, the value retured will not match the
+behavior of the Cache Manager. The only reason to use B<sys> is that
+B<livesys> wasn't available in older versions of AFS.
=head1 OUTPUT
=head1 SEE ALSO
-L<fs_sysname(1)>
+L<fs_sysname(1)>,
+L<livesys(1)>
I<IBM AFS Quick Beginnings>
Server uses its contents as the basis for a list of interfaces to register
in the VLDB. Otherwise, it uses the list of network interfaces configured
with the operating system. It then removes from the list any addresses
-that appear in the F</usr/vice/etc/NetRestrict> file, if it exists. The
+that appear in the F</usr/afs/local/NetRestrict> file, if it exists. The
File Server records the resulting list in the F</usr/afs/local/sysid> file
and registers the interfaces in the VLDB. The database server processes
use a similar procedure when initializing, to determine which interfaces
--- /dev/null
+=head1 NAME
+
+voldump - Dump an AFS volume without using the Volume Server
+
+=head1 SYNOPSIS
+
+B<voldump> B<-part> <I<partition>> B<-volumeid> <I<volume id>>
+ [B<-file> <I<dump file>>] [B<-verbose>] [B<-help>]
+
+B<voldump> B<-p> <I<partition>> B<-vo> <I<volume id>>
+ [B<-f> <I<dump file>>] [B<-ve>] [B<-h>]
+
+=head1 DESCRIPTION
+
+B<voldump> dumps an AFS volume in the format used by B<vos dump> without
+using the Volume Server. It must be run on the file server machine and
+usually must be run as the superuser C<root> to have permissions to read
+the file server data. It's primary use is to recover data from a file
+server machine where the Volume Server cannot be started for some reason.
+
+The dump output will go to standard output, or to a file if B<-file> is
+specified. B<vos restore> can be used to load the resulting dump into a
+new AFS volume. B<voldump> always does a full dump.
+
+=head1 CAUTIONS
+
+Normally, use B<vos dump> instead of this command. B<voldump> is a tool
+of last resort to try to extract data from the raw data structures stored
+on the file server machine and is not as regularly tested or used as the
+normal B<vos dump> implementation.
+
+If the AFS volume being dumped changes while B<voldump> is running, the
+results may be inconsistent. If the File Server and Volume Server are
+running, stop them with B<bos shutdown> or a similar method before running
+this command.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-part> <I<partition>>
+
+Names the partition on which the volume to be dumped is located.
+B<voldump> does not take the normal full range of ways of specifying a
+partition. Instead, I<partition> must be either a single letter between
+C<a> and C<z>, corresponding to F</vicepa> through F</vicepz>, or the full
+path to the file server partition. C<aa> is not recognized; use
+F</vicepaa> instead.
+
+=item B<-volumeid> <I<volume id>>
+
+Specifies the ID of the volume to dump. The volume must be specified by
+numeric ID, not by name.
+
+=item B<-file> <I<dump file>>
+
+Specifies the output file for the dump. If this option is not given, the
+volume will be dumped to standard output.
+
+=item B<-verbose>
+
+Asks for a verbose trace of the dump process. This trace information will
+be sent to standard error.
+
+=back
+
+=head1 EXAMPLES
+
+The following command dumps the volume 1936964939 on the F</vicepb>
+partition to the file F</tmp/volume.dump>:
+
+ % voldump -part /vicepb -volumeid 1936964939 -file /tmp/volume.dump
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must have read access to the file server data stored in the
+specified partition. Usually, this means that the issuer must be the
+local superuser C<root> on the file server machine.
+
+=head1 SEE ALSO
+
+L<bos_shutdown(8)>,
+L<volserver(8)>,
+L<vos_dump(1)>,
+L<vos_restore(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2005 Russ Allbery <rra@stanford.edu>
+
+This documentation is covered by the IBM Public License Version 1.0. This
+man page was written by Russ Allbery for OpenAFS.
git://git.openafs.org / openafs.git / commitdiff