Skip to content

Commit ee059cc

Browse files
authored
docs: README
1 parent 2df57a7 commit ee059cc

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ A text-based user interface (TUI) for the [Slurm Workload Manager](https://slurm
77

88
<img alt="turm demo" src="https://user-images.githubusercontent.com/7303830/228503846-3e5abc04-2c1e-422e-844b-d12ca097403a.gif" width="100%" />
99

10-
`turm` accepts the same options as `squeue` (see [man squeue](https://slurm.schedmd.com/squeue.html#SECTION_OPTIONS)). Use `turm --help` to get a list of all available options.
10+
`turm` accepts the same options as `squeue` (see [man squeue](https://slurm.schedmd.com/squeue.html#SECTION_OPTIONS)). Use `turm --help` to get a list of all available options. For example, to show only your own jobs, sorted by descending job ID, including all job states (i.e., including completed and failed jobs):
11+
```shell
12+
turm --sort=-id --me --states=ALL
13+
```
1114

1215
## Installation
1316

@@ -52,19 +55,6 @@ In your `config.fish` or in a separate `completions/turm.fish` file, add the fol
5255
turm completion fish | source
5356
```
5457

55-
## Usage
56-
57-
Run `turm` in your terminal. By default, it shows all jobs in the queue.
58-
```shell
59-
turm
60-
```
61-
62-
You can filter the jobs using the same options as `squeue`. For example, to show only your own jobs, sorted by descending job ID, including all job states (i.e., including completed and failed jobs):
63-
64-
```shell
65-
turm --sort=-id --me --states=ALL
66-
```
67-
6858
## How it works
6959

7060
`turm` obtains information about jobs by parsing the output of `squeue`.

0 commit comments

Comments
 (0)