Skip to content
This repository has been archived by the owner on Sep 16, 2024. It is now read-only.

Commit

Permalink
Added some usage information.
Browse files Browse the repository at this point in the history
  • Loading branch information
FokkeDijkstra committed May 14, 2024
1 parent 0925b7c commit 254f970
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ Tool for giving a quick overview of Slurm job statistics.
Inspired by https://github.com/birc-aeh/slurm-utils/blob/master/jobinfo
from Anders Halager <aeh@birc.au.dk>

# Usage

```
jobinfo [-h] [-d] [-l] jobid`
collates job information from the 'sstat', 'sacct' and 'squeue' SLURM commands
to give a uniform interface for both current and historical jobs.
positional arguments:
jobid the jobid to query
optional arguments:
-h, --help show this help message and exit
-d, --debug Shows extra information about how the data is gathered
-l, --long Shows more information about the job
```

# Release notes:

## v1.0 - 2024-04-15
Expand Down

0 comments on commit 254f970

Please sign in to comment.