Fileserver: Add the /vicepXX/NeverAttach flag to skip mounting a partition
[openafs.git] / doc / man-pages / pod1 / pts_listentries.pod.in
1 =head1 NAME
2
3 pts_listentries - Displays all users or groups in the Protection Database
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<pts listentries> [B<-users>] [B<-groups>] S<<< [B<-cell> <I<cell name>>] >>>
11     [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
12
13 B<pts liste> [B<-u>] [B<-g>] S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] 
14              [B<-f>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<pts listentries> command displays the name and AFS ID of all
22 Protection Database entries of the indicated type. It also displays the
23 AFS ID of each entry's owner and creator.
24
25 To display all user and machine entries, either include the B<-users> flag
26 or omit both it and the B<-groups> flag.  To display all group entries,
27 include the B<-groups> flag. To display all entries, provide both flags.
28
29 =head1 OPTIONS
30
31 =over 4
32
33 =item B<-users>
34
35 Displays user and machine entries.
36
37 =item B<-groups>
38
39 Displays group entries.
40
41 =include fragments/pts-common.pod
42
43 =back
44
45 =head1 OUTPUT
46
47 The output includes a line for each entry, with information in four
48 columns that have the following headers:
49
50 =over 4
51
52 =item Name
53
54 The entry's name.
55
56 =item ID
57
58 The entry's AFS ID (AFS UID for a user or machine, negative AFS GID for a
59 group).
60
61 =item Owner
62
63 The AFS ID of the user or group that owns the entry.
64
65 =item Creator
66
67 The AFS ID of the user who created the entry (the system:administrators
68 group is listed as the creator of the entry for C<anonymous> and the
69 system groups, but it is not otherwise possible for a group to create
70 groups).
71
72 =back
73
74 In general, the entries appear in the order in which they were created.
75
76 =head1 EXAMPLES
77
78 The following example displays both user and group entries.
79
80    % pts listentries -users -groups
81    Name                          ID  Owner Creator
82    system:administrators       -204   -204    -204
83    system:anyuser              -101   -204    -204
84    system:authuser             -102   -204    -204
85    anonymous                  32766   -204    -204
86    admin                          1   -204   32766
87    pat                          100   -204       1
88    smith                        101   -204       1
89    pat:friends                 -206    100     100
90    staff                       -207   -204       1
91
92 =head1 PRIVILEGE REQUIRED
93
94 The issuer must belong to the system:administrators group.
95
96 =head1 SEE ALSO
97
98 L<pts(1)>,
99 L<pts_creategroup(1)>,
100 L<pts_createuser(1)>,
101 L<pts_examine(1)>
102
103 =head1 COPYRIGHT
104
105 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
106
107 This documentation is covered by the IBM Public License Version 1.0.  It was
108 converted from HTML to POD by software written by Chas Williams and Russ
109 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.