doc: clarify the fs wscell manpage
[openafs.git] / doc / man-pages / pod1 / fs_wscell.pod
1 =head1 NAME
2
3 fs_wscell - Returns the name of the cell to which a machine belongs
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs wscell> [B<-help>]
11
12 B<fs ws> [B<-h>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<fs wscell> command returns the name of the local machine's home
20 cell.
21
22 =head1 OPTIONS
23
24 =over 4
25
26 =item B<-help>
27
28 Prints the online help for this command. All other valid options are
29 ignored.
30
31 =back
32
33 =head1 OUTPUT
34
35 The output displays the client's current home cell, thus the contents of the
36 local F</usr/vice/etc/ThisCell> file at the time when the client was started,
37 in the format
38
39    This workstation belongs to cell '<cellname>'
40
41 =head1 EXAMPLES
42
43 The following example results when the fs wscell is issued on a machine in
44 the Example Organization cell:
45
46    % fs wscell
47    This workstation belongs to cell 'example.org'
48
49 =head1 PRIVILEGE REQUIRED
50
51 None
52
53 =head1 SEE ALSO
54
55 L<fs_whereis(1)>,
56 L<fs_whichcell(1)>
57
58 =head1 COPYRIGHT
59
60 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
61
62 This documentation is covered by the IBM Public License Version 1.0.  It was
63 converted from HTML to POD by software written by Chas Williams and Russ
64 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.