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