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