Import Upstream version 1.8.5
[hcoop/debian/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 [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
13
14 B<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
22 The B<pts listentries> command displays the name and AFS ID of all
23 Protection Database entries of the indicated type. It also displays the
24 AFS ID of each entry's owner and creator.
25
26 To display all user and machine entries, either include the B<-users> flag
27 or omit both it and the B<-groups> flag. To display all group entries,
28 include 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
36 Displays user and machine entries.
37
38 =item B<-groups>
39
40 Displays group entries.
41
42 =include fragments/pts-common.pod
43
44 =back
45
46 =head1 OUTPUT
47
48 The output includes a line for each entry, with information in four
49 columns that have the following headers:
50
51 =over 4
52
53 =item Name
54
55 The entry's name.
56
57 =item ID
58
59 The entry's AFS ID (AFS UID for a user or machine, negative AFS GID for a
60 group).
61
62 =item Owner
63
64 The AFS ID of the user or group that owns the entry.
65
66 =item Creator
67
68 The AFS ID of the user who created the entry (the system:administrators
69 group is listed as the creator of the entry for C<anonymous> and the
70 system groups, but it is not otherwise possible for a group to create
71 groups).
72
73 =back
74
75 In general, the entries appear in the order in which they were created.
76
77 =head1 EXAMPLES
78
79 The 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
95 The issuer must belong to the system:administrators group.
96
97 =head1 SEE ALSO
98
99 L<pts(1)>,
100 L<pts_creategroup(1)>,
101 L<pts_createuser(1)>,
102 L<pts_examine(1)>
103
104 =head1 COPYRIGHT
105
106 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
107
108 This documentation is covered by the IBM Public License Version 1.0. It was
109 converted from HTML to POD by software written by Chas Williams and Russ
110 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.