DOC: Factored common text out of the vos_backup and vos_dump man pages Change-Id: I84bd722834297778ab2e719996b2f8528d8706d6 Reviewed-on: http://gerrit.openafs.org/7126 Reviewed-by: Simon Wilkinson <simonxwilkinson@gmail.com> Tested-by: Simon Wilkinson <simonxwilkinson@gmail.com> Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com> Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
doc: replace hostnames with IETF example hostnames There were several different real and made-up hostnames and company names used throughout our documentation examples. The IETF has reserved "example.com" and other "example" TLDs for use in examples (RFC 2606). Replace almost all references to ABC Corporation, DEF Corporation, and State University, as well as "abc.com", "bigcell.com", "def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu", "stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com". Standardize on "Example Corporation", "Example Network", "Example Organization" (example.com, example.net, and example.org). The Scout documentation in the Admin Guide contains PNG images that contain the old cell names, so I left those references until the images can be replaced. Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367 Reviewed-on: http://gerrit.openafs.org/6697 Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com> Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Documentation: vos dump -verbose outputs to stderr vos dump -verbose sends its logging to stderr, not to stdout (where it would potentially collide with the dump data itself). FIXES 124911 Change-Id: I515c50df59d2f376787969df59b6e01e244ecbc7 Reviewed-on: http://gerrit.openafs.org/1044 Reviewed-by: Russ Allbery <rra@stanford.edu> Tested-by: Russ Allbery <rra@stanford.edu>
Update vos suite manpages Larger collection of all vos suite commands, including but not limited to: -- documented all commands / options, verified against both 1.4 and 1.5 tree (including the common -encrypt/-noresolve options) -- correct order, POD formatting and synopsis for all commands' options -- shorthand synopsis provided for all commands that missed it, with proper non-ambiguous command abbreviations of all options -- POD synopsis formatted to 80-columns in commands where it was running over -- for newer options, documented which OpenAFS version they became available -- proper manpage links using L<> in vos.pod Reviewed-on: http://gerrit.openafs.org/609 Tested-by: Derrick Brashear <shadow@dementia.org> Reviewed-by: Derrick Brashear <shadow@dementia.org>
Move restorevol to bin from sbin restorevol only requires access to a dump file and write access to the directory in which the dump is being unpacked. It doesn't require being a superuser, so it should be installed in bin instead of sbin. Also move the man page to section 1 and update references accordingly. Reviewed-on: http://gerrit.openafs.org/333 Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
man-page-vos-dump-flags-20090526 LICENSE BSD Add documentation of the -clone and -omitdirs flags to vos dump.
man-page-restorevol-20090518 LICENSE IPL10 FIXES 124791 Add man page for restorevol.
man-page-name-underscore-20071111 The NAME heading for man pages can't contain a space in the program side or the man pages won't index with some man implementations.
pretty-html-synopsis-20060228 Implement proper synopsis wrapping for HTML generation. This was done in three pieces. First, add HTML-specific tags to the POD to mark the synopsis for HTML purposes so that we can apply style information to it. Second, update the style sheet to indent all lines except for the first in the synopsis section. Third, add the appropriate S<> tags around option and argument pairs so that we don't wrap between the option and its argument. Unfortunately, due to the <I<foo>> style that looks nicer for other reasons, we have to use the very verbose S<<< >>>. Oh well.
man-page-whitespace-20051220 Remove all trailing whitespace while we have the chance and there are no merge issues yet.
man1-editing-pass-20051209 Complete an initial editing and cleanup pass for all section one man pages. Fix various conversion problems, formatting inconsistencies, and obvious problems. Please note that no editing for content has yet been done; this is solely editing for formatting and correct conversion to POD. Also, add some additional section five man pages that were omitted from the first conversion run due to unusual file names, and globally replace CAVEATS with CAUTIONS in the man pages to match the original section name. The section one man pages should now be in reasonable shape and ready for additional review and further updates, although there are probably still remaining obvious problems. ==================== This delta was composed from multiple commits as part of the CVS->Git migration. The checkin message with each commit was inconsistent. The following are the additional commit messages. ==================== This file got the wrong name when it was originally committed. Fix.
man-page-conversion-20051208 This is the initial conversion of the AFS Adminstrators Reference into POD for use as man pages. The man pages are now generated via pod2man from regen.sh so that only those working from CVS have to have pod2man available. The Makefile only installs. The pages have also been sorted out into pod1, pod5, and pod8 directories, making conversion to the right section of man page easier without maintaining a separate list and allowing for names to be duplicated between pod5 and pod1 or pod8 (which will likely be needed in a few cases). This reconversion is done with a new script based on work by Chas Williams. In some cases, the output is worse than the previous POD pages, but this is a more comprehensive conversion. This is only the first step, and this initial conversion has various problems. In addition, the file man pages that didn't have simple names have not been converted in this pass and will be added later. Some of the man pages have syntax problems and all of them have formatting errors. The next editing pass, coming shortly, will clean up most of the remaining mess.