doc/man-pages/pod1/pts_setfields.pod.in

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