openafs/doc/man-pages/pod1/livesys.pod
Andrew Deason 477f270656 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 12:18:48 -08:00

75 lines
1.9 KiB
Plaintext

=head1 NAME
livesys - Reports the configured CPU/operating system type
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<livesys>
=for html
</div>
=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<OpenAFS Quick Start Guides> and I<OpenAFS 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, by itself, on a single
line.
=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)>
The I<OpenAFS Quick Start Guides> at L<http://docs.openafs.org/>.
The I<OpenAFS Administration Guide> at
L<http://docs.openafs.org/AdminGuide/>.
=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.