openafs/doc/man-pages/pod1/fs_wscell.pod
Stephan Wiesand bd15a5f56f doc: clarify the fs wscell manpage
What's displayed by fs wscell is not necessarily the current content
of ThisCell, but that at the time of starting the client. Say so.

FIXES 133339

Change-Id: Id3351f1236e5061340eb07041d4ce3e4de69a1a1
Reviewed-on: https://gerrit.openafs.org/12537
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
2017-03-02 22:38:59 -05:00

65 lines
1.2 KiB
Plaintext

=head1 NAME
fs_wscell - Returns the name of the cell to which a machine belongs
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<fs wscell> [B<-help>]
B<fs ws> [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<fs wscell> command returns the name of the local machine's home
cell.
=head1 OPTIONS
=over 4
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 OUTPUT
The output displays the client's current home cell, thus the contents of the
local F</usr/vice/etc/ThisCell> file at the time when the client was started,
in the format
This workstation belongs to cell '<cellname>'
=head1 EXAMPLES
The following example results when the fs wscell is issued on a machine in
the Example Organization cell:
% fs wscell
This workstation belongs to cell 'example.org'
=head1 PRIVILEGE REQUIRED
None
=head1 SEE ALSO
L<fs_whereis(1)>,
L<fs_whichcell(1)>
=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.