[3561] | 1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.41.1. |
---|
| 2 | .TH PKUSERS "1" "janvier 2013" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" |
---|
[2703] | 3 | .SH NOM |
---|
[3561] | 4 | pkusers \- page de manuel de pkusers (PyKota) 1.27alpha14_unofficial |
---|
[3485] | 5 | .SH SYNOPSIS |
---|
| 6 | .B pkusers |
---|
| 7 | [\fIoptions\fR] [\fIusernames|groupnames\fR] |
---|
[2703] | 8 | .SH DESCRIPTION |
---|
[3485] | 9 | Manages PyKota users or users groups. |
---|
| 10 | .SH OPTIONS |
---|
[2703] | 11 | .TP |
---|
[3485] | 12 | \fB\-h\fR, \fB\-\-help\fR |
---|
| 13 | show this help message and exit. |
---|
[2703] | 14 | .TP |
---|
[3485] | 15 | \fB\-v\fR, \fB\-\-version\fR |
---|
| 16 | show the version number and exit. |
---|
[2703] | 17 | .TP |
---|
[3485] | 18 | \fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR |
---|
| 19 | loads additional options and arguments from a file, |
---|
| 20 | one per line. |
---|
[2703] | 21 | .TP |
---|
[3485] | 22 | \fB\-a\fR, \fB\-\-add\fR |
---|
| 23 | Add new, or modify existing, users or groups. |
---|
[2937] | 24 | .TP |
---|
[3485] | 25 | \fB\-b\fR BALANCE, \fB\-\-balance\fR=\fIBALANCE\fR |
---|
| 26 | Set an user's account balance. The value can also be |
---|
| 27 | increased or decreased when the value is prefixed with |
---|
| 28 | \&'+' or '\-'. Users groups don't have a real account |
---|
| 29 | balance, instead the sum of their members' account |
---|
| 30 | balances is used. |
---|
[2703] | 31 | .TP |
---|
[3485] | 32 | \fB\-C\fR COMMENT, \fB\-\-comment\fR=\fICOMMENT\fR |
---|
| 33 | Associate a textual comment with a change in an user's |
---|
| 34 | account balance. Only meaningful when \fB\-\-balance\fR is |
---|
| 35 | also used. |
---|
[2703] | 36 | .TP |
---|
[3485] | 37 | \fB\-d\fR, \fB\-\-delete\fR |
---|
| 38 | Delete the specified users or groups. Also purge the |
---|
| 39 | print quota entries and printing history matching the |
---|
| 40 | specified users or groups. |
---|
[2703] | 41 | .TP |
---|
[3485] | 42 | \fB\-D\fR DESCRIPTION, \fB\-\-description\fR=\fIDESCRIPTION\fR |
---|
| 43 | Set a textual description for the specified users or |
---|
| 44 | groups. |
---|
[2703] | 45 | .TP |
---|
[3485] | 46 | \fB\-e\fR EMAIL, \fB\-\-email\fR=\fIEMAIL\fR |
---|
| 47 | Set an user's email address. If this parameter begins |
---|
| 48 | with '@' then the username is prepended to this |
---|
| 49 | parameter to form a valid email address. |
---|
[2719] | 50 | .TP |
---|
[3485] | 51 | \fB\-g\fR, \fB\-\-groups\fR |
---|
| 52 | Manage users groups instead of users. |
---|
[2703] | 53 | .TP |
---|
[3485] | 54 | \fB\-i\fR INGROUPS, \fB\-\-ingroups\fR=\fIINGROUPS\fR |
---|
| 55 | Put the specified users into the specified groups. |
---|
| 56 | When combined with the \fB\-\-remove\fR option, users are |
---|
| 57 | removed from the specified groups instead. |
---|
[2703] | 58 | .TP |
---|
[3485] | 59 | \fB\-l\fR LIMITBY, \fB\-\-limitby\fR=\fILIMITBY\fR |
---|
| 60 | Set the limiting factor for the specified users or |
---|
| 61 | groups. Can be any of 'quota' (limit by number of |
---|
| 62 | pages per printer), 'balance' (limit by number of |
---|
| 63 | credits), 'noquota' (no limit but accounting done), |
---|
| 64 | \&'nochange' (no limit and no accounting), or 'noprint' |
---|
| 65 | (printing is denied). The two latter ones are not |
---|
| 66 | supported for groups. |
---|
[2703] | 67 | .TP |
---|
[3485] | 68 | \fB\-L\fR, \fB\-\-list\fR |
---|
| 69 | Display detailed informations about the specified |
---|
| 70 | users or groups. |
---|
[2703] | 71 | .TP |
---|
[3485] | 72 | \fB\-o\fR OVERCHARGE, \fB\-\-overcharge\fR=\fIOVERCHARGE\fR |
---|
| 73 | Set the overcharging factor applied to the specified |
---|
| 74 | users when computing the cost of a print job. Any |
---|
| 75 | floating point value can be used, allowing you to |
---|
| 76 | express your creativity... |
---|
| 77 | .TP |
---|
| 78 | \fB\-r\fR, \fB\-\-remove\fR |
---|
| 79 | When combined with the \fB\-\-ingroups\fR option, remove users |
---|
| 80 | from the specified users groups. |
---|
| 81 | .TP |
---|
| 82 | \fB\-s\fR, \fB\-\-skipexisting\fR |
---|
| 83 | If \fB\-\-add\fR is used, ensure that existing users or groups |
---|
| 84 | won't be modified. |
---|
| 85 | .SS "examples:" |
---|
[2703] | 86 | .IP |
---|
[3485] | 87 | pkusers \fB\-\-add\fR john paul george ringo/ringo@example.com |
---|
| 88 | Would make users 'john', 'paul', 'george' and 'ringo' be known to PyKota. |
---|
| 89 | User 'ringo''s email address would be set to 'ringo@example.com'. |
---|
[2703] | 90 | .IP |
---|
[3485] | 91 | pkusers \fB\-\-add\fR \fB\-\-groups\fR coders it |
---|
| 92 | Would create two users groups named 'coders' and 'it'. |
---|
[2703] | 93 | .IP |
---|
[3485] | 94 | pkusers \fB\-\-add\fR \fB\-\-ingroups\fR coders,it jerome |
---|
| 95 | Would add user 'jerome' and put him into the 'coders' and 'it' groups. |
---|
| 96 | Both groups would have to be existing. |
---|
[2703] | 97 | .IP |
---|
[3485] | 98 | pkusers \fB\-\-limitby\fR balance \fB\-\-balance\fR 10.0 john |
---|
| 99 | Would give 10.0 credits to 'john' and make his printing be limited by his |
---|
| 100 | account balance. |
---|
[2703] | 101 | .IP |
---|
[3485] | 102 | pkusers \fB\-\-balance\fR +10.0 \fB\-\-comment\fR "He paid with his blood." jerome |
---|
| 103 | Would add 10.0 credits to 'jerome''s account and register a comment |
---|
| 104 | associated with his payment. |
---|
[2703] | 105 | .IP |
---|
[3485] | 106 | pkusers \fB\-\-delete\fR "jer*" "rach*" |
---|
| 107 | Would delete all user accounts whose names begin with either 'jer' or |
---|
| 108 | \&'rach'. |
---|
[2703] | 109 | .IP |
---|
[3485] | 110 | pkusers \fB\-\-overcharge\fR \fB\-1\fR.50 theboss |
---|
| 111 | Would make the boss earn money whenever he prints. |
---|
[2703] | 112 | .IP |
---|
[3485] | 113 | pkusers \fB\-\-email\fR @example.com |
---|
| 114 | Would set the email address for each existing user to username@example.com |
---|
[2703] | 115 | .IP |
---|
[3485] | 116 | pkusers \fB\-\-list\fR |
---|
| 117 | Would list all users. |
---|
| 118 | .SS "licensing terms:" |
---|
[2703] | 119 | .IP |
---|
[3561] | 120 | (c) 2003\-2013 Jerome Alet \- alet@librelogiciel.com |
---|
[3485] | 121 | This program is free software: you can redistribute it and/or modify it |
---|
| 122 | under the terms of the GNU General Public License as published by the Free |
---|
| 123 | Software Foundation, either version 3 of the License, or (at your option) |
---|
| 124 | any later version. |
---|
[2703] | 125 | .IP |
---|
[3485] | 126 | This program is distributed in the hope that it will be useful, but |
---|
| 127 | WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
---|
| 128 | or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
---|
| 129 | for more details. |
---|
[2703] | 130 | .IP |
---|
[3485] | 131 | You should have received a copy of the GNU General Public License along |
---|
| 132 | with this program. If not, see <http://www.gnu.org/licenses/>. |
---|