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