Skip to content

Commit

Permalink
doc: Update docs of interactive mode
Browse files Browse the repository at this point in the history
  • Loading branch information
luator committed Nov 7, 2024
1 parent dd8878f commit 676e523
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@ get some information about finished and running jobs, as well as to stop running

To enter the command prompt, press ESC. You should now see the following prompt:

::
.. code-block:: text
Enter command, e.g. list_jobs, list_running_jobs, list_successful_jobs,
list_idle_jobs, show_job, stop_remaining_jobs
>>>
============= COMMAND MODE =============
Type 'help' or '?' to list commands.
Press enter with empty line to exit command mode.
You now may enter one of the listed commands or simply press Enter to leave the prompt
without executing a command.
>>>
You now may enter one of the commands listed below (you can use tab-completion). To
leave the command mode, simply press Enter without a command.

.. important::

Expand All @@ -67,6 +69,11 @@ Commands
name collision with an actual config value, this should be fine and much easier than
adding a dedicated directive.
.. confval:: help

Show help. Without argument, a list of all commands is shown. Specify a command as
argument to see the help for that command.

.. confval:: list_jobs

List IDs of all jobs that have been submitted so far (including finished ones).
Expand Down Expand Up @@ -94,5 +101,3 @@ Commands

This will not stop submission of new jobs. If you want to stop cluster_utils
completely, press Ctrl + C instead.


0 comments on commit 676e523

Please sign in to comment.