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