Update pueue -h text in Readme
@@ -143,7 +143,7 @@ There are also detailed sections for (hopefully) every important feature:
On top of that, there is a help option (-h) for all commands.
```text
-Pueue client 0.10.0
+Pueue client 0.12.2
Arne Beer <contact@arne.beer>
Interact with the Pueue daemon
@@ -156,45 +156,48 @@ FLAGS:
-V, --version Prints version information
OPTIONS:
- -c, --config <config> Path to a specific pueue config daemon, that should be used. This
- ignores all other config files
+ -c, --config <config> Path to a specific pueue config file to use. This ignores all other
+ config files
SUBCOMMANDS:
add Enqueue a task for execution
- clean Remove all finished tasks from the list (also clears logs)
+ clean Remove all finished tasks from the list
completions Generates shell completion files. This can be ignored during normal
operations
edit Edit the command or path of a stashed or queued task.
- This edits the command of the task by default.
+ The command is edited by default.
enqueue Enqueue stashed tasks. They'll be handled normally afterwards
follow Follow the output of a currently running task. This command works like tail
-f
- group Manage groups. By default, this will simply display all known groups
+ group Use this to add or remove groups. By default, this will simply display all
+ known groups
help Prints this message or the help of the given subcommand(s)
- kill Kill specific running tasks or various groups of tasks
+ kill Kill specific running tasks or whole task groups. Kills all tasks of the
+ default group when no ids are provided
log Display the log output of finished tasks. Prints either all logs or only the
logs of specified tasks
- parallel Set the amount of allowed parallel tasks
- pause Pause either running tasks or specific groups of tasks.
- By default, pauses the default queue and all its tasks.
+ parallel Set the amount of allowed parallel tasks. By default, adjusts the amount of
+ the default group
+ pause Either pause running tasks or specific groups of tasks.
+ By default, pauses the default group and all its tasks.
A paused queue (group) won't start any new tasks.
remove Remove tasks from the list. Running or paused tasks need to be killed first
- reset Kill all running tasks on user behalf, remove all tasks and reset max_task_id
+ reset Kill all tasks, clean up afterwards and reset EVERYTHING!
restart Restart task(s). Identical tasks will be created and by default enqueued. By
default, a new task will be created
send Send something to a task. Useful for sending confirmations such as 'y\n'
shutdown Remotely shut down the daemon. Should only be used if the daemon isn't
started by a service manager
start Resume operation of specific tasks or groups of tasks.
- By default, this resumes the default queue and all its tasks.
+ By default, this resumes the default group and all its tasks.
Can also be used force-start specific tasks.
- stash Stashed tasks won't be automatically started. Either enqueue them, to be
- normally handled or explicitly start them
+ stash Stashed tasks won't be automatically started. You have to enqueue them or
+ start them by hand
status Display the current status of all tasks
switch Switches the queue position of two commands. Only works on queued and stashed
commands
wait Wait until tasks are finished. This can be quite useful for scripting. By
- default, this will wait for all tasks in the default queue to finish. Note:
+ default, this will wait for all tasks in the default group to finish. Note:
This will also wait for all tasks that aren't somehow 'Done'. Includes:
[Paused, Stashed, Locked, Queued, ...]
```
