doc/man-pages/pod1/pts_setfields.pod

   1 =head1 NAME
   2
   3 pts setfields - Sets privacy flags or quota for a Protection Database entry
   4
   5 =head1 SYNOPSIS
   6
   7 B<pts setfields> B<-nameorid> <I<user or group name or id>>+
   8     [B<-access> <I<set privacy flags>>]
   9     [B<-groupquota> <I<set limit on group creation>>]
  10     [B<-cell> <I<cell name>>] [B<-noauth>] [B<-force>] [B<-help>]
  11
  12 B<pts setf> B<-na> <I<user or group name or id>>+
  13     [B<-a> <I<set privacy flags>>]
  14     [B<-g> <I<set limit on group creation>>] [B<-c> <I<cell name>>]
  15     [B<-no>] [B<-f>] [B<-h>]
  16
  17 =head1 DESCRIPTION
  18
  19 The B<pts setfields> command sets the group-creation quota, the privacy
  20 flags, or both, associated with each user, machine, or group entry
  21 specified by the B<-nameorid> argument.
  22
  23 To examine the current quota and privacy flags, use the B<pts examine>
  24 command.
  25
  26 =head1 CAUTIONS
  27
  28 Changing a machine or group's group-creation quota is allowed, but not
  29 recommended. The concept is meaningless for machines and groups, because
  30 it is impossible to authenticate as a group or machine.
  31
  32 Similarly, some privacy flag settings do not have a sensible
  33 interpretation. L<OPTIONS> specifies the appropriate settings.
  34
  35 =head1 OPTIONS
  36
  37 =over 4
  38
  39 =item B<-nameorid> <I<user or group name or id>>+
  40
  41 Specifies the name or AFS UID of each user, the IP address (complete or
  42 wildcard-style) of each machine, or the name or AFS GID of each machine
  43 for which to set privacy flags or group-creation quota. It is acceptable
  44 to mix users, machines, and groups on the same command line, as well as
  45 names (IP addresses for machines) and IDs. Precede the GID of each group
  46 with a hyphen to indicate that it is negative.
  47
  48 =item B<-access> <I<privacy flags>>
  49
  50 Specifies the privacy flags to apply to each entry. Provide a string of
  51 five characters, one for each of the permissions. If this option is
  52 omitted, the current setting remains unchanged.
  53
  54 Set each flag to achieve the desired combination of permissions. If the
  55 following list does not mention a certain setting, it is not
  56 acceptable. For further discussion of the privacy flags, see
  57 L<pts_examine(1)>.
  58
  59 =over 4
  60
  61 =item *
  62
  63 The first flag determines who can use the B<pts examine> command to
  64 display information from a user, machine or group's Protection Database
  65 entry.
  66
  67 =over 4
  68
  69 =item *
  70
  71 Set it to lowercase C<s> to permit the members of the
  72 system:administrators group to display a user, machine, or group entry,
  73 and the associated user to display a user entry.
  74
  75 =item *
  76
  77 Set it to uppercase C<S> to permit anyone who can access the cell's
  78 database server machines to display a user, machine, or group entry.
  79
  80 =back
  81
  82 =item *
  83
  84 The second flag determines who can use the B<pts listowned> command to
  85 list the groups that a user or group owns.
  86
  87 =over 4
  88
  89 =item *
  90
  91 Set it to the hyphen (C<->) to permit the members of the
  92 system:administrators group and a user to list the groups he or she owns,
  93 or to permit the members of the system:administrators group and a group's
  94 owner to list the groups that a group owns.
  95
  96 =item *
  97
  98 Set it to uppercase letter C<O> to permit anyone who can access the cell's
  99 database server machines to list the groups owned by a machine or group
 100 entry.
 101
 102 =back
 103
 104 =item *
 105
 106 The third flag determines who can use the B<pts membership> command to
 107 list the groups to which a user or machine belongs, or the users and
 108 machines that belong to a group.
 109
 110 =over 4
 111
 112 =item *
 113
 114 Set it to the hyphen (C<->) to permit the members of the
 115 system:administrators group and a user to list the groups he or she
 116 belongs to, to permit the members of the B<system:administrators> group to
 117 list the groups a machine belongs to, or to permit the members of the
 118 system:administrators group and a group's owner to list the users and
 119 machines that belong to it.
 120
 121 =item *
 122
 123 Set it to lowercase C<m> to permit members of a group to list the other
 124 members. (For user and machine entries, this setting is equivalent to the
 125 hyphen.)
 126
 127 =item *
 128
 129 Set it to uppercase C<M> to permit anyone who can access the cell's
 130 database server machines to list membership information for a user,
 131 machine or group.
 132
 133 =back
 134
 135 =item *
 136
 137 The fourth flag determines who can use the B<pts adduser> command to add
 138 users and machines as members of a group. This flag has no sensible
 139 interpretation for user and machine entries, but must be set nonetheless,
 140 preferably to the hyphen.
 141
 142 =over 4
 143
 144 =item *
 145
 146 Set it to the hyphen (C<->) to permit the members of the
 147 system:administrators group and the owner of the group to add members.
 148
 149 =item *
 150
 151 Set it to lowercase C<a> to permit members of a group to add other
 152 members.
 153
 154 =item *
 155
 156 Set it to uppercase C<A> to permit anyone who can access the cell's
 157 database server machines to add members to a group.
 158
 159 =back
 160
 161 =item *
 162
 163 The fifth flag determines who can use the B<pts removeuser> command to
 164 remove users and machines from membership in a group. This flag has no
 165 sensible interpretation for user and machine entries, but must be set
 166 nonetheless, preferably to the hyphen.
 167
 168 =over 4
 169
 170 =item *
 171
 172 Set it to the hyphen (C<->) to permit the members of the
 173 system:administrators group and the owner of the group to remove members.
 174
 175 =item *
 176
 177 Set it to lowercase C<r> to permit members of a group to remove other
 178 members.
 179
 180 =back
 181
 182 =back
 183
 184 =item B<-groupquota> <I<group creation quota>>
 185
 186 Specifies the number of additional groups a user can create (it does not
 187 matter how many he or she has created already). Do not include this
 188 argument for a group or machine entry.
 189
 190 =item B<-cell> <I<cell name>>
 191
 192 Names the cell in which to run the command. For more details, see
 193 L<pts(1)>.
 194
 195 =item B<-noauth>
 196
 197 Assigns the unprivileged identity anonymous to the issuer. For more
 198 details, see L<pts(1)>.
 199
 200 =item B<-force>
 201
 202 Enables the command to continue executing as far as possible when errors
 203 or other problems occur, rather than halting execution at the first error.
 204
 205 =item B<-help>
 206
 207 Prints the online help for this command. All other valid options are
 208 ignored.
 209
 210 =back
 211
 212 =head1 EXAMPLES
 213
 214 The following example changes the privacy flags on the group C<operators>,
 215 retaining the default values of the first, second and third flags, but
 216 setting the fourth and fifth flags to enable the group's members to add
 217 and remove other members.
 218
 219    % pts setfields -nameorid operators -access S-Mar
 220
 221 The following example changes the privacy flags and sets group quota on
 222 the user entry C<admin>. It retains the default values of the first,
 223 fourth, and fifth flags, but sets the second and third flags, to enable
 224 anyone to list the groups that C<admin> owns and belongs to.  Users
 225 authenticated as C<admin> can create an additional 50 groups.
 226
 227    % pts setfields -nameorid admin -access SOM-- -groupquota 50
 228
 229 =head1 PRIVILEGE REQUIRED
 230
 231 To edit group entries or set the privacy flags on any type of entry, the
 232 issuer must own the entry or belong to the system:administrators group. To
 233 set group-creation quota on a user entry, the issuer must belong to the
 234 system:administrators group.
 235
 236 =head1 SEE ALSO
 237
 238 L<pts(1)>,
 239 L<pts_adduser(1)>,
 240 L<pts_examine(1)>,
 241 L<pts_listowned(1)>,
 242 L<pts_membership(1)>,
 243 L<pts_removeuser(1)>
 244
 245 =head1 COPYRIGHT
 246
 247 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 248
 249 This documentation is covered by the IBM Public License Version 1.0.  It was
 250 converted from HTML to POD by software written by Chas Williams and Russ
 251 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.