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