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