jimzah/openafs
1
0
Fork 0
mirror of https://git.openafs.org/openafs.git synced 2025-01-18 23:10:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
18b4243772
openafs/doc/man-pages/pod8/upserver.pod

131 lines
4.6 KiB
Plaintext
Raw Normal View History

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.
2005-12-08 12:14:33 +00:00
=head1 NAME
upserver - Initializes the server portion of the Update Server
=head1 SYNOPSIS
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.
2006-03-01 05:02:29 +00:00
=for html
<div class="synopsis">
B<upserver> [<I<directory>>+] S<<< [B<-crypt> <I<directory>>+] >>>
doc: upserver manpage fixes Add missing option -rxbind. Change-Id: I1e6057c3747cf6c502bf14e1d094b8b64691615d Reviewed-on: http://gerrit.openafs.org/10405 Reviewed-by: Derrick Brashear <shadow@your-file-system.com> Tested-by: Derrick Brashear <shadow@your-file-system.com>
2013-07-27 02:54:20 +01:00
S<<< [B<-clear> <I<directory>>+] >>> S<<< [B<-auth> <I<directory>>+] >>>
[B<-rxbind>] [B<-help>]
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.
2006-03-01 05:02:29 +00:00
=for html
</div>
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.
2005-12-08 12:14:33 +00:00
=head1 DESCRIPTION
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
The B<upserver> command initializes the server portion of the Update
Server (the C<upserver> process). In the conventional configuration, its
binary file is located in the F</usr/afs/bin> directory on a file server
machine.
The B<upserver> 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 B<upserver> command specifies which of the directories on the local
disk are eligible for distribution in response to requests from the client
portion of the Update Server (the B<upclient> process) running on other
machines. If no directories are specified, the B<upserver> process
distributes the contents of any directory on its local disk.
The B<upserver> process can distribute a directory's contents in encrypted
or unencrypted form. By default, it does not use encryption unless an
B<upclient> process requests it (this default is equivalent to setting the
B<-clear> flag). When the B<-crypt> flag is provided, the B<upserver>
process only fulfills requests for encrypted transfer.
The B<upclient> and B<upserver> processes always mutually authenticate,
whether or not the data they pass is encrypted; they use the key with the
highest key version number in the F</usr/afs/etc/KeyFile> file to
construct a server ticket for mutual authentication.
This command does not use the syntax conventions of the AFS command
suites. Provide the command name and all option names in full.
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.
2005-12-08 12:14:33 +00:00
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.
2005-12-09 14:48:56 +00:00
=head1 CAUTIONS
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.
2005-12-08 12:14:33 +00:00
Do not use the Update Server to distribute the contents of the
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
F</usr/afs/etc> directory without the B<-crypt> flag. The contents of
this directory are sensitive.
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.
2005-12-08 12:14:33 +00:00
=head1 OPTIONS
=over 4
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
=item <I<directory>>+
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.
2005-12-08 12:14:33 +00:00
Names each directory to distribute in unencrypted form (because they
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
appear before the first B<-crypt> or B<-clear> flag on the command
line). If this argument is omitted, all directories on the machine's local
disk are eligible for distribution.
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.
2005-12-08 12:14:33 +00:00
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
=item B<-crypt> <I<directory>>+
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.
2005-12-08 12:14:33 +00:00
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
Precedes a list of one or more directories that the B<upserver> process
distributes only in encrypted form.
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.
2005-12-08 12:14:33 +00:00
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
=item B<-clear> <I<directory>>+
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.
2005-12-08 12:14:33 +00:00
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
Precedes a list of one or more directories that the B<upserver> process
distributes in unencrypted form unless the B<upclient> process requests
them in encrypted form. Use this argument only if a list of directories
headed by the B<-crypt> flag precedes it on the command line.
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.
2005-12-08 12:14:33 +00:00
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
=item B<-auth> <I<directory>>+
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.
2005-12-08 12:14:33 +00:00
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
Precedes a list of one or more directories which the upserver process
distributes using a form of encryption that is intermediate in complexity
and security between the unencrypted and encrypted levels set by the
B<-clear> and B<-crypt> arguments. Do not use this argument, because the
B<upclient> process does not have a corresponding argument that it can use
to request data transfer at this level.
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.
2005-12-08 12:14:33 +00:00
doc: upserver manpage fixes Add missing option -rxbind. Change-Id: I1e6057c3747cf6c502bf14e1d094b8b64691615d Reviewed-on: http://gerrit.openafs.org/10405 Reviewed-by: Derrick Brashear <shadow@your-file-system.com> Tested-by: Derrick Brashear <shadow@your-file-system.com>
2013-07-27 02:54:20 +01:00
=item B<-rxbind>
Bind the Rx socket to the primary interface only. (If not specified, the Rx
socket will listen on all interfaces.)
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
=item B<-help>
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.
2005-12-08 12:14:33 +00:00
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
Prints the online help for this command. All other valid options are
ignored.
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.
2005-12-08 12:14:33 +00:00
=back
=head1 EXAMPLES
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
The following example bos create command defines and starts an B<upserver>
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>
2012-02-11 16:43:30 +00:00
process on the host machine C<fs1.example.com>. The last parameter (enclosed
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
in quotes) instructs the B<upserver> process to distribute the contents of
the F</usr/afs/bin> directory in unencrypted form and the contents of the
F</usr/afs/etc> directory in encrypted form.
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.
2005-12-08 12:14:33 +00:00
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>
2012-02-11 16:43:30 +00:00
% bos create -server fs1.example.com -instance upserver -type simple \
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
-cmd "/usr/afs/bin/upserver /usr/afs/bin -crypt /usr/afs/etc"
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.
2005-12-08 12:14:33 +00:00
=head1 PRIVILEGE REQUIRED
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
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.
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.
2005-12-08 12:14:33 +00:00
=head1 SEE ALSO
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
L<BosConfig(5)>,
L<bos_create(8)>,
L<upclient(8)>
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.
2005-12-08 12:14:33 +00:00
=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.
Reference in New Issue Copy Permalink