Updating the man page for 0.6 (also removed some verbal short forms)
authorllbatlle@taga
Wed, 16 Jul 2008 14:10:46 +0200
changeset 232 7201bb3ee30d
parent 231 558b281b88f5
child 233 b9643c784d84
Updating the man page for 0.6 (also removed some verbal short forms)
ts.1
--- a/ts.1	Wed Jul 16 13:51:09 2008 +0200
+++ b/ts.1	Wed Jul 16 14:10:46 2008 +0200
@@ -5,7 +5,7 @@
 .\" that should have been distributed together with this file.
 .\" 
 .\" Note: I took the gnu 'ls' man page as an example.
-.TH TS 1 2007-12 "Task Spooler 0.5"
+.TH TS 1 2008-08 "Task Spooler 0.6"
 .SH NAME
 ts \- task spooler. A simple unix batch system
 .SH SYNOPSIS
@@ -43,7 +43,7 @@
 results be collected:
 .TP
 .B "\-n"
-Don't store the standard output/error in a file at
+Do not store the standard output/error in a file at
 .B $TMPDIR
 - let it use the
 file descriptors decided by the calling process. If it is not used, the
@@ -57,7 +57,7 @@
 have a .gz extension.
 .TP
 .B "\-f"
-Don't put the task into background. Wait the queue and the command run without
+Don not put the task into background. Wait the queue and the command run without
 getting detached of the terminal. The exit code will be that of the command, and
 if used together with \-n, no result will be stored in the queue.
 .TP
@@ -79,7 +79,7 @@
 .B "\-d"
 Run the command only if the command before finished well (errorlevel = 0). This new
 task enqueued depends on the result of the previous command. If the task is not run,
-it's considered as failed for further dependencies.
+it is considered as failed for further dependencies.
 .SH ACTIONS
 Instead of giving a new command, we can use the parameters for other purposes:
 .TP
@@ -92,9 +92,9 @@
 processes related to the queue. This will not kill the command being
 run at that time.
 
-It's not reliable to think that
+It is not reliable to think that
 .B ts -K
-will finish when the server is really killed. By now it's a race condition.
+will finish when the server is really killed. By now it is a race condition.
 .TP
 .B "\-C"
 Clear the results of finished jobs from the queue.
@@ -113,7 +113,9 @@
 .TP
 .B "\-c [id]"
 Run the system's cat to the output file of the named job, or the last
-running/run if not specified.
+running/run if not specified. It will block until all the output can be
+sent to standard output, and will exit with the job errorlevel as in
+\fB\-c\fR.
 .TP
 .B "\-p [id]"
 Show the pid of the named job, or the last running/run if not specified.
@@ -149,11 +151,29 @@
 .TP
 .B "\-V"
 Show the program version.
+.SH MULTI-SLOT
+.B ts
+by default offers a queue where each job runs only after the previous finished.
+Nevertheless, you can change the maximum number of jobs running at once with
+the
+.B "\-S <num>"
+parameter. We call that number the
+\fIamount of slots\fR.
+When increasing this setting, queued waiting jobs will be run
+at once until reaching the maximum set. When decreasing this setting, no other
+job will be run until it can meet the amount of running jobs set.
+.BR
+When using an amount of slots greater than 1, the action of some commands
+may change a bit. For example, \fB\-t\fR without \fIjobid\fR will tail the first
+job running, and \fB\-d\fR will try to set the dependency with the last job added.
+.TP
+.B "\-S <num>"
+Set the maximum amount of running jobs at once.
 .SH ENVIRONMENT
 .TP
 .B "TS_MAXFINISHED"
 Limit the number of job results (finished tasks) you want in the queue. Use this
-option if you're tired of
+option if you are tired of
 .B \-C.
 .TP
 .B "TS_ONFINISH"
@@ -180,12 +200,12 @@
 Each queue has a related unix socket. You can specify the socket path with this
 environment variable. This way, you can have a queue for your heavy disk
 operations, another for heavy use of ram., and have a simple script/alias
-wrapper over ts for those special queues. If it's not specified, it will be
+wrapper over ts for those special queues. If it is not specified, it will be
 .B $TMPDIR/socket-ts.[uid].
 .TP
 .B "TS_MAILTO"
 Send the letters with job results to the address specified in this variable.
-Otherwise, they're sent to
+Otherwise, they are sent to
 .B $USER
 or if not defined,
 .B nobody.
@@ -198,12 +218,12 @@
 flags together.
 .TP
 .B "USER"
-As seen above, it's used for the mail destination if
+As seen above, it is used for the mail destination if
 .B TS_MAILTO
 is not specified.
 .TP
 .B "TS_SAVELIST"
-If it's defined when starting the queue server (probably the first
+If it is defined when starting the queue server (probably the first
 .B ts
 command run), on SIGTERM the queue status will be saved to the file pointed
 by this environment variable - for example, at system shutdown.
@@ -223,11 +243,11 @@
 
 .SH BUGS
 .B ts
-expects a simple command line. It doesn't start a shell parser.
+expects a simple command line. It does not start a shell parser.
 If you want to run complex shell commands, you may want to run them through
 .B sh -c 'commands...'
 Also, remember that stdin/stdout/stderr will be detached, so
-don't use your shell's redirection operators when you put a job into background.
+do not use your shell's redirection operators when you put a job into background.
 You can use them inside the
 .B sh -c
 in order to set redirections to the command run.
@@ -243,7 +263,7 @@
 .SH NOTES
 This page describes
 .B ts
-as in version 0.5. Other versions may differ. The file
+as in version 0.6. Other versions may differ. The file
 .B TRICKS
 found in the distribution package can show some ideas on special uses of
 .B ts.