Skip to content

[WIP] docs: update example usage of hostlist command #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[WIP] docs: update example usage of hostlist command #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/basic_usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Basic Usage

You can use the command line to process your hostlist strings by using the following command:

``python cla_hostlist.py <method> <args>...``
``hostlist <method> <args>...``

Here is a list of all of the methods available:

Expand Down Expand Up @@ -45,6 +45,6 @@ Here is a list of all of the methods available:

For example, to execute the expand function displayed above, users can run the following:

``python cla_hostlist.py -e node[1-4]``
``hostlist -e node[1-4]``

This will return ``node1,node2,node3,node4``.
16 changes: 8 additions & 8 deletions docs/source/manpage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ py-hostlist Man Page
SYNOPSIS
--------

``python cla_hostlist.py [OPTION] ARGS``
``hostlist [OPTION] ARGS``

DESCRIPTION
-----------
Expand Down Expand Up @@ -98,31 +98,31 @@ EXAMPLES

1. To expand a hostlist:

``python cla_hostlist.py -e foo[1-5]``
``hostlist -e foo[1-5]``

2. To set a custom delimiter:

``python cla_hostlist.py -d [DELIMITER] foo[1-5]``
``hostlist -d [DELIMITER] foo[1-5]``

3. To see the first N hosts:

``python cla_hostlist.py -s [N] foo[1-5]``
``hostlist -s [N] foo[1-5]``

4. To exclude a node from a hostlist:

``python cla_hostlist.py -x foo[1-5] [EXCLUDED NODE] [EXCLUDED NODE]...``
``hostlist -x foo[1-5] [EXCLUDED NODE] [EXCLUDED NODE]...``

5. To find the nth host in a hostlist:

``python cla_hostlist.py -n [N] foo[1-5]``
``hostlist -n [N] foo[1-5]``

6. To remove all occurences of a node from a hostlist:

``python cla_hostlist.py -R [NODE] foo[1-5]``
``hostlist -R [NODE] foo[1-5]``

7. To find the position of a specific node:

``python cla_hostlist.py -F [NODE] foo[1-50]``
``hostlist -F [NODE] foo[1-50]``



Expand Down