From: Russ Allbery Date: Wed, 28 Dec 2005 00:35:21 +0000 (+0000) Subject: * Backport man pages from upstream CVS. (Closes: #79763) X-Git-Tag: debian/1.4.0-3~1 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=db648ff3393c575652ddd1160c4be8c0c1998211;p=packages%2Fo%2Fopenafs.git * Backport man pages from upstream CVS. (Closes: #79763) --- diff --git a/debian/README.Debian b/debian/README.Debian index 0c0262a5a..755fa84cb 100644 --- a/debian/README.Debian +++ b/debian/README.Debian @@ -37,12 +37,7 @@ Documentation For the complete OpenAFS manual, install openafs-doc. This is the same documentation as found at , and is unfortunately outdated in several respects, but it's the best that we - have at present. The Administrative Reference manual is one of the most - useful, as it contains man-page-like pages on most of the AFS commands. - - No manual pages are included. Work is underway upstream to write man - pages for all of the commands based on the old HTML reference manual, - but that work is not complete yet. + have at present. If want to set up a new cell, read README.servers and then look at the example session in configuration-transcript.txt.gz in this directory. @@ -128,4 +123,4 @@ PAM Authentication the openafs-kpasswd package to get the administrative utilities for managing those Kerberos accounts. - -- Russ Allbery , Tue Dec 20 17:24:51 2005 + -- Russ Allbery , Tue Dec 27 15:53:28 2005 diff --git a/debian/changelog b/debian/changelog index 3d871b32d..704ff9901 100644 --- a/debian/changelog +++ b/debian/changelog @@ -10,6 +10,7 @@ openafs (1.4.0-3) unstable; urgency=low compiler other than the default system compiler. (Closes: #338306) * Call kernel-version correctly from prep-modules, which fixes build issues with manually-built kernels. (Closes: #344851) + * Backport man pages from upstream CVS. (Closes: #79763) * Include afsmonitor and livesys in openafs-client. * Include volinfo in openafs-fileserver. * Document FAM's lack of support for AFS's security model and recommend @@ -26,7 +27,7 @@ openafs (1.4.0-3) unstable; urgency=low goes into each package. * Don't ignore make distclean errors. - -- Russ Allbery Mon, 26 Dec 2005 16:17:15 -0800 + -- Russ Allbery Tue, 27 Dec 2005 15:34:16 -0800 openafs (1.4.0-2) unstable; urgency=low diff --git a/debian/doc/build-man b/debian/doc/build-man new file mode 100755 index 000000000..127449516 --- /dev/null +++ b/debian/doc/build-man @@ -0,0 +1,56 @@ +#!/bin/sh +# +# Install man pages, but fixing up paths as we go. All of the man pages +# are written to use the Transarc paths, and this script fixes those paths to +# be correct for the chosen configure options as the man pages are installed. + +set -e + +manpage="$1" +dest="$2" + +afsbackupdir=/var/lib/openafs/backup +afsbosconfigdir=/etc/openafs +afsconfdir=/etc/openafs/server +afsdbdir=/var/lib/openafs/db +afslocaldir=/etc/openafs/server-local +afslogsdir=/var/log/openafs +afssrvlibexecdir=/usr/lib/openafs +viceetcdir=/etc/openafs + +# Build a particular man page. Takes the section title, the section number, +# the filename of the POD page, and the output file. +buildpage () { + pod2man -c "$1" -r OpenAFS -s "$2" "$3" | \ + sed -e "s%/usr/afs/local/BosConfig%${afsbosconfigdir}/BosConfig%g" \ + -e "s%/usr/afs/etc%${afsconfdir}%g" \ + -e "s%/usr/afs/backup%${afsbackupdir}%g" \ + -e "s%/usr/afs/bin%${afssrvlibexecdir}%g" \ + -e "s%/usr/afs/db%${afsdbdir}%g" \ + -e "s%/usr/afs/local%${afslocaldir}%g" \ + -e "s%/usr/afs/logs%${afslogsdir}%g" \ + -e "s%/usr/vice/etc%${viceetcdir}%g" > "$4" +} + +# Create the output directories. +mkdir -p man1 man5 man8 + +# Do the work with lots of calls to buildpage. +cd pod1 +for f in *.pod ; do + buildpage 'AFS Command Reference' 1 "$f" \ + ../man1/`echo "$f" | sed 's/\.pod$//'`.1 +done +cd .. +cd pod5 +for f in *.pod ; do + buildpage 'AFS File Reference' 5 "$f" \ + ../man5/`echo "$f" | sed 's/\.pod$//'`.5 +done +cd .. +cd pod8 +for f in *.pod ; do + buildpage 'AFS Command Reference' 8 "$f" \ + ../man8/`echo "$f" | sed 's/\.pod$//'`.8 +done +cd .. diff --git a/debian/doc/pod1/afs.pod b/debian/doc/pod1/afs.pod new file mode 100644 index 000000000..0ae96a171 --- /dev/null +++ b/debian/doc/pod1/afs.pod @@ -0,0 +1,563 @@ +=head1 NAME + +afs - Introduction to AFS commands + +=head1 DESCRIPTION + +AFS provides many commands that enable users and system administrators to +use and customize its features. Many of the commands belong to the +following categories, called I. + +=over 4 + +=item backup + +Interface for configuring and operating the AFS Backup System. + +=item bos + +Interface to the Basic Overseer (BOS) Server for administering server +processes and configuration files. + +=item fs + +Interface for administering access control lists (ACLs), the Cache +Manager, and other miscellaneous file system functions. + +=item fstrace + +Interface for tracing Cache Manager operations when debugging problems. + +=item kas + +Interface to the Authentication Server for administering security and +authentication information. + +=item pts + +Interface to the Protection Server for administering AFS ID and group +membership information. + +=item uss + +Interface for automated administration of user accounts. + +=item vos + +Interface to the Volume Server and Volume Location (VL) Server for +administering volumes. + +=back + +In addition, there are several commands that do not belong to +suites. + +=head2 AFS Command Syntax + +AFS commands that belong to suites have the following structure: + +I I B<-switch> >[+] [B<-flag>] + +=head3 Command Names + +Together, the I and I make up the I. + +The I specifies the group of related commands to which the +command belongs, and indicates which command interpreter and server +process perform the command. AFS has several command suites, including +B, B, B, B, B, B and B. Some of +these suites have an interactive mode in which the issuer omits the +I portion of the command name. + +The I tells the command interpreter and server process +which action to perform. Most command suites include several operation +codes. The man pages for each command name describe each operation code in +detail, and the I describes how to use them +in the context of performing administrative tasks. + +Several AFS commands do not belong to a suite and so their names do not +have a I portion. Their structure is otherwise similar to +the commands in the suites. + +=head3 Options + +The term I