jimzah/openafs
1
0
Fork 0
mirror of https://git.openafs.org/openafs.git synced 2025-01-19 07:20:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
c0ff0c7f42
openafs/doc/man-pages/pod1/livesys.pod

75 lines
1.9 KiB
Plaintext
Raw Normal View History

man-page-misc-improvements-20051221 Add new man pages for livesys and voldump. Fix the man page for sys to say what it actually does, rather than implying that it works like livesys, and to recommend livesys instead. Fix a path error in the NetInfo documentation. Update the README for the current status, including listing all installed commands that don't have man pages. (There may still be some subcommands that don't have man pages but aren't listed.)
2005-12-22 07:34:49 +00:00
=head1 NAME
livesys - Reports the configured CPU/operating system type
=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">
man-page-misc-improvements-20051221 Add new man pages for livesys and voldump. Fix the man page for sys to say what it actually does, rather than implying that it works like livesys, and to recommend livesys instead. Fix a path error in the NetInfo documentation. Update the README for the current status, including listing all installed commands that don't have man pages. (There may still be some subcommands that don't have man pages but aren't listed.)
2005-12-22 07:34:49 +00:00
B<livesys>
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-misc-improvements-20051221 Add new man pages for livesys and voldump. Fix the man page for sys to say what it actually does, rather than implying that it works like livesys, and to recommend livesys instead. Fix a path error in the NetInfo documentation. Update the README for the current status, including listing all installed commands that don't have man pages. (There may still be some subcommands that don't have man pages but aren't listed.)
2005-12-22 07:34:49 +00:00
=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
Remove references to IBM AFS Change references to the documentation sets that we still ship to reference the OpenAFS manuals instead of the IBM AFS manuals. Remove references to the IBM AFS/DFS Migration documentation, since that doesn't appear to be available anywhere any more, replacing them where relevant to more generic references to the DFS documentation. Add links to docs.openafs.org for mentions of the manuals in SEE ALSO, and standardize on one link format. Replace a few references to the IBM AFS Release Notes with the actual information in those notes, or drop the reference if it doesn't seem particularly useful. Change-Id: Ie9666842f1315891c6a9c37c0424200f4b78bff7 Reviewed-on: http://gerrit.openafs.org/2031 Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-26 18:20:57 +01:00
I<OpenAFS Quick Start Guides> and I<OpenAFS Administration Guide> explain
man-page-misc-improvements-20051221 Add new man pages for livesys and voldump. Fix the man page for sys to say what it actually does, rather than implying that it works like livesys, and to recommend livesys instead. Fix a path error in the NetInfo documentation. Update the README for the current status, including listing all installed commands that don't have man pages. (There may still be some subcommands that don't have man pages but aren't listed.)
2005-12-22 07:34:49 +00:00
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
doc: Fix livesys output formatting If we indent text here, the formatting codes are not interpreted, and the text is output "raw". So currently, we actually see "I<system_type>" in this section, which is a bit confusing. Saying the actual output with string substitutions and stuff here doesn't seem very helpful when the output doesn't have any constant text in it. Just describe what the output is instead; an example immediately follows if this is unclear. Change-Id: Ib3e0f0c5143afa2dd41a655ff3908c791026a426 Reviewed-on: http://gerrit.openafs.org/10411 Reviewed-by: Derrick Brashear <shadow@your-file-system.com> Tested-by: Derrick Brashear <shadow@your-file-system.com>
2013-11-04 16:04:42 +00:00
The machine's system type appears as a text string, by itself, on a single
line.
man-page-misc-improvements-20051221 Add new man pages for livesys and voldump. Fix the man page for sys to say what it actually does, rather than implying that it works like livesys, and to recommend livesys instead. Fix a path error in the NetInfo documentation. Update the README for the current status, including listing all installed commands that don't have man pages. (There may still be some subcommands that don't have man pages but aren't listed.)
2005-12-22 07:34:49 +00:00
=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)>
Remove references to IBM AFS Change references to the documentation sets that we still ship to reference the OpenAFS manuals instead of the IBM AFS manuals. Remove references to the IBM AFS/DFS Migration documentation, since that doesn't appear to be available anywhere any more, replacing them where relevant to more generic references to the DFS documentation. Add links to docs.openafs.org for mentions of the manuals in SEE ALSO, and standardize on one link format. Replace a few references to the IBM AFS Release Notes with the actual information in those notes, or drop the reference if it doesn't seem particularly useful. Change-Id: Ie9666842f1315891c6a9c37c0424200f4b78bff7 Reviewed-on: http://gerrit.openafs.org/2031 Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-26 18:20:57 +01:00
The I<OpenAFS Quick Start Guides> at L<http://docs.openafs.org/>.
man-page-misc-improvements-20051221 Add new man pages for livesys and voldump. Fix the man page for sys to say what it actually does, rather than implying that it works like livesys, and to recommend livesys instead. Fix a path error in the NetInfo documentation. Update the README for the current status, including listing all installed commands that don't have man pages. (There may still be some subcommands that don't have man pages but aren't listed.)
2005-12-22 07:34:49 +00:00
Remove references to IBM AFS Change references to the documentation sets that we still ship to reference the OpenAFS manuals instead of the IBM AFS manuals. Remove references to the IBM AFS/DFS Migration documentation, since that doesn't appear to be available anywhere any more, replacing them where relevant to more generic references to the DFS documentation. Add links to docs.openafs.org for mentions of the manuals in SEE ALSO, and standardize on one link format. Replace a few references to the IBM AFS Release Notes with the actual information in those notes, or drop the reference if it doesn't seem particularly useful. Change-Id: Ie9666842f1315891c6a9c37c0424200f4b78bff7 Reviewed-on: http://gerrit.openafs.org/2031 Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
2010-05-26 18:20:57 +01:00
The I<OpenAFS Administration Guide> at
L<http://docs.openafs.org/AdminGuide/>.
man-page-misc-improvements-20051221 Add new man pages for livesys and voldump. Fix the man page for sys to say what it actually does, rather than implying that it works like livesys, and to recommend livesys instead. Fix a path error in the NetInfo documentation. Update the README for the current status, including listing all installed commands that don't have man pages. (There may still be some subcommands that don't have man pages but aren't listed.)
2005-12-22 07:34:49 +00:00
=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.
Reference in New Issue Copy Permalink