1ws_allocate(1) General Commands Manual ws_allocate(1)
2
6 ws_allocate - create a workspace directory and return its path
7
10 ws_allocate [-h] [-x] [-g] [-F FILESYSTEM] [-r DAYS] [-m MAILADDRESS]
11 [-c COMMENT] NAME DURATION
12
15 Create a workspace for the calling user with name NAME which will exist
16 for DURATION days. The command will always return the full name of the
17 created directory on stdout, and will print some information to stderr.
18 A workspace has a limited lifetime, which can be restricted by the
19 administrator. The DURATION might be cut to that maximum, a warning
20 will be printed in that case.
21 A workspace can be extended if allowed by the administrator, who might
23 limit the number of extensions.
24 A reminder email can be sent to address MAILADDRESS (or address from
26 ~/.ws_user.conf) DAYS before the workspace expires. This will done
27 probably during a nightly cleanup run, do not expect it to come exactly
28 in time but rather the night after the warning period is met.
29 The idea of the workspace is to allow the administrator to keep control
31 of filespace in working filesystems, and to avoid the situations that
32 data of past and finished projects/jobs is idling for ever on disks. A
33 user can create and dispose arbitrary number of workspaces, they are
34 cheap, and can be created e.g. for each job.
35 For the administrator, workspaces offer further advantages, like beeing
37 able to migrate users to another filesystem over time, and to do load‐
38 balancing over directories and filesystems.
39 From the system side, workspaces will be deleted after beeing expired.
41 A friendly user can release workspaces before the expiration date using
42 ws_release which will mark the workspace for future deletion and make
43 the data unavailable for the user.
44 Deletion is probably a task done once a night and not immediately.
46 If a workspace was forgotten and expired, it might make sense to con‐
48 tact the administrator, as he probaly can restore a workspace for some
49 time, if disk space is not low. Check if ws_restore is available to
50 restore workspaces that are still in the hidden area.
51
54 -h display usage help text
55 -x extend an existing workspace until today + DURATION days. The
57 number of extensions can be limited. Can be combined with -m to
58 add a mail address and with -r to add reminder to existing
59 workspaces. If used with 0 as duration, it does not consume an
60 extension.
61 -F select the filesystem to create the workspace in, there is
63 always a default for this. See ws_list -l for a list of avail‐
64 able filesystems.
65 -m mailaddress to send reminder mail to, can be combined with -x to
67 add mailaddress to existing workspace (combine with duration 0).
68 -c comment to attach to workspace, can be combined with -x to
70 change comment of an existing workspace (combine with duration
71 0).
72 -r DAYS
74 reminder email will be sent DAYS days before the workspace will
75 expire, can be combined with -x to add reminder to existing
76 workspace. This could be sent in the night after the exact point
77 in time, during a cleanup. See ws_send_ical for a way to send
78 calendar entries.
79 -g a group-workspace will be created, that is a workspace that can
81 be seen by other members of current group with ws_list -g and
82 the workspace itself is created group readable.
83
87 create a workspace for 10 days:
88 ws_allocate myworkspace 10
89
92 ~/.ws_user.conf can contain an email address to send reminders to, if
93 no -m option is used.
94 It has the form
97 mail: user@domain
98
101 Written by Holger Berger
102
105 ws_release, ws_list, ws_find, ws_restore, ws_send_ical
106USER COMMANDS March 2013 ws_allocate(1)