Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Documentation

Online documentation is available here:

http://clustershell.readthedocs.org/
https://clustershell.readthedocs.io/

The Sphinx documentation source is available under the doc/sphinx directory.
Type 'make' to see all available formats (you need Sphinx installed and
Expand Down Expand Up @@ -90,7 +90,7 @@ Web site:

Online documentation:

http://clustershell.readthedocs.org/
https://clustershell.readthedocs.io/

Github source repository:

Expand Down
2 changes: 1 addition & 1 deletion conf/groups.conf
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ClusterShell node groups main configuration file
#
# Please see `man 5 groups.conf` and
# http://clustershell.readthedocs.org/en/latest/config.html#node-groups
# https://clustershell.readthedocs.io/en/latest/config.html#node-groups
# for further details.
#
# NOTE: This is a simple group configuration example file, not a
Expand Down
6 changes: 3 additions & 3 deletions doc/man/man1/clubak.1
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CLUBAK" "1" "2025-01-23" "1.9.3" "ClusterShell User Manual"
.TH "CLUBAK" 1 "2025-01-23" "1.9.3" "ClusterShell User Manual"
.SH NAME
clubak \- format output from clush/pdsh-like output and more
.SH SYNOPSIS
Expand Down Expand Up @@ -133,12 +133,12 @@ node2: 9
.sp
\fBcluset\fP(1), \fBclush\fP(1), \fBnodeset\fP(1), \fBgroups.conf\fP(5).
.sp
<http://clustershell.readthedocs.org/>
\fI\%https://clustershell.readthedocs.io/\fP
.SH BUG REPORTS
.INDENT 0.0
.TP
.B Use the following URL to submit a bug report or feedback:
<https://github.com/cea\-hpc/clustershell/issues>
\fI\%https://github.com/cea\-hpc/clustershell/issues\fP
.UNINDENT
.SH AUTHOR
Stephane Thiell <sthiell@stanford.edu>
Expand Down
6 changes: 3 additions & 3 deletions doc/man/man1/cluset.1
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CLUSET" "1" "2025-01-23" "1.9.3" "ClusterShell User Manual"
.TH "CLUSET" 1 "2025-01-23" "1.9.3" "ClusterShell User Manual"
.SH NAME
cluset \- compute advanced cluster node set operations
.SH SYNOPSIS
Expand Down Expand Up @@ -477,12 +477,12 @@ command and also to conform with ClusterShell\(aqs \(dqclu*\(dq command nomencla
.sp
\fBclubak\fP(1), \fBclush\fP(1), \fBnodeset\fP(1), \fBgroups.conf\fP(5).
.sp
<http://clustershell.readthedocs.org/>
\fI\%https://clustershell.readthedocs.io/\fP
.SH BUG REPORTS
.INDENT 0.0
.TP
.B Use the following URL to submit a bug report or feedback:
<https://github.com/cea\-hpc/clustershell/issues>
\fI\%https://github.com/cea\-hpc/clustershell/issues\fP
.UNINDENT
.SH AUTHOR
Stephane Thiell <sthiell@stanford.edu>
Expand Down
6 changes: 3 additions & 3 deletions doc/man/man1/clush.1
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CLUSH" "1" "2025-01-23" "1.9.3" "ClusterShell User Manual"
.TH "CLUSH" 1 "2025-01-23" "1.9.3" "ClusterShell User Manual"
.SH NAME
clush \- execute shell commands on a cluster
.SH SYNOPSIS
Expand Down Expand Up @@ -408,12 +408,12 @@ File in which interactive \fBclush\fP command history is saved.
.sp
\fBclubak\fP(1), \fBcluset\fP(1), \fBnodeset\fP(1), \fBreadline\fP(3), \fBclush.conf\fP(5), \fBgroups.conf\fP(5).
.sp
<http://clustershell.readthedocs.org/>
\fI\%https://clustershell.readthedocs.io/\fP
.SH BUG REPORTS
.INDENT 0.0
.TP
.B Use the following URL to submit a bug report or feedback:
<https://github.com/cea\-hpc/clustershell/issues>
\fI\%https://github.com/cea\-hpc/clustershell/issues\fP
.UNINDENT
.SH AUTHOR
Stephane Thiell <sthiell@stanford.edu>
Expand Down
6 changes: 3 additions & 3 deletions doc/man/man1/nodeset.1
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "NODESET" "1" "2025-01-23" "1.9.3" "ClusterShell User Manual"
.TH "NODESET" 1 "2025-01-23" "1.9.3" "ClusterShell User Manual"
.SH NAME
nodeset \- compute advanced nodeset operations
.SH SYNOPSIS
Expand Down Expand Up @@ -501,12 +501,12 @@ command and also to conform with ClusterShell\(aqs \(dqclu*\(dq command nomencla
.sp
\fBclubak\fP(1), \fBcluset\fP(1), \fBclush\fP(1), \fBgroups.conf\fP(5).
.sp
<http://clustershell.readthedocs.org/>
\fI\%https://clustershell.readthedocs.io/\fP
.SH BUG REPORTS
.INDENT 0.0
.TP
.B Use the following URL to submit a bug report or feedback:
<https://github.com/cea\-hpc/clustershell/issues>
\fI\%https://github.com/cea\-hpc/clustershell/issues\fP
.UNINDENT
.SH AUTHOR
Stephane Thiell <sthiell@stanford.edu>
Expand Down
11 changes: 9 additions & 2 deletions doc/man/man5/clush.conf.5
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CLUSH.CONF" "5" "2025-01-23" "1.9.3" "ClusterShell User Manual"
.TH "CLUSH.CONF" 5 "2025-01-23" "1.9.3" "ClusterShell User Manual"
.SH NAME
clush.conf \- Configuration file for clush
.SH DESCRIPTION
.sp
\fBclush\fP(1) configuration files are in Python\(aqs ConfigParser format.
.SS Locations
.sp
\fBclush\fP(1) obtains configuration options from the following sources in the
following order:
.INDENT 0.0
Expand Down Expand Up @@ -221,7 +224,11 @@ from \fIclush.conf\fP\&. External commands whose outputs were used by \fBclush\
.sp
\fBclush\fP(1), \fBgroups.conf\fP(5), \fBsshpass\fP(1), \fBsudo\fP(8).
.sp
<http://clustershell.readthedocs.org/>
\fI\%https://clustershell.readthedocs.io/\fP
.sp
Python ConfigParser
.sp
\fI\%https://docs.python.org/3/library/configparser.html\fP
.SH AUTHOR
Stephane Thiell, <sthiell@stanford.edu>
.SH COPYRIGHT
Expand Down
4 changes: 2 additions & 2 deletions doc/man/man5/groups.conf.5
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "GROUPS.CONF" "5" "2025-01-23" "1.9.3" "ClusterShell User Manual"
.TH "GROUPS.CONF" 5 "2025-01-23" "1.9.3" "ClusterShell User Manual"
.SH NAME
groups.conf \- Configuration file for ClusterShell node groups
.SH DESCRIPTION
Expand Down Expand Up @@ -206,7 +206,7 @@ Local groups.conf user configuration file (default installation for pip \-\-user
.sp
\fBclubak\fP(1), \fBcluset\fP(1), \fBclush\fP(1), \fBnodeset\fP(1)
.sp
<http://clustershell.readthedocs.org/>
\fI\%https://clustershell.readthedocs.io/\fP
.SH AUTHOR
Stephane Thiell, <sthiell@stanford.edu>
.SH COPYRIGHT
Expand Down
11 changes: 11 additions & 0 deletions doc/sphinx/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ clush
clush.conf
^^^^^^^^^^

The *clush.conf* files are parsed with Python's `ConfigParser`_

Locations
"""""""""

The following configuration file defines system-wide default values for
several ``clush`` tool parameters::

Expand All @@ -34,6 +39,12 @@ will be tried first for ``clush``::

$CLUSTERSHELL_CFGDIR/clush.conf

Settings
""""""""

Settings that apply to all ``clush`` :ref:`run modes <clushmode-config>` are
contained within the ``[Main]`` section.

The following table describes available ``clush`` config file settings.

+-----------------+----------------------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ Main changes in 1.7
^^^^^^^^^^^^^^^^^^^

This new version comes with a refreshed documentation, based on the Sphinx
documentation generator, available on http://clustershell.readthedocs.org.
documentation generator, available on https://clustershell.readthedocs.io.

The main new features of version 1.7 are described below.

Expand Down
2 changes: 1 addition & 1 deletion doc/txt/clubak.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ SEE ALSO

``cluset``\(1), ``clush``\(1), ``nodeset``\(1), ``groups.conf``\(5).

http://clustershell.readthedocs.org/
https://clustershell.readthedocs.io/

BUG REPORTS
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/txt/cluset.txt
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ SEE ALSO

``clubak``\(1), ``clush``\(1), ``nodeset``\(1), ``groups.conf``\(5).

http://clustershell.readthedocs.org/
https://clustershell.readthedocs.io/

BUG REPORTS
===========
Expand Down
11 changes: 10 additions & 1 deletion doc/txt/clush.conf.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Configuration file for `clush`
DESCRIPTION
===========

``clush``\(1) configuration files are in Python's ConfigParser format.

Locations
---------

``clush``\(1) obtains configuration options from the following sources in the
following order:

Expand Down Expand Up @@ -186,4 +191,8 @@ SEE ALSO

``clush``\(1), ``groups.conf``\(5), ``sshpass``\(1\), ``sudo``\(8\).

http://clustershell.readthedocs.org/
https://clustershell.readthedocs.io/

Python ConfigParser

https://docs.python.org/3/library/configparser.html
2 changes: 1 addition & 1 deletion doc/txt/clush.txt
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ SEE ALSO

``clubak``\(1), ``cluset``\(1), ``nodeset``\(1), ``readline``\(3), ``clush.conf``\(5), ``groups.conf``\(5).

http://clustershell.readthedocs.org/
https://clustershell.readthedocs.io/

BUG REPORTS
===========
Expand Down
2 changes: 1 addition & 1 deletion doc/txt/groups.conf.txt
Original file line number Diff line number Diff line change
Expand Up @@ -184,4 +184,4 @@ SEE ALSO

``clubak``\(1), ``cluset``\(1), ``clush``\(1), ``nodeset``\(1)

http://clustershell.readthedocs.org/
https://clustershell.readthedocs.io/
2 changes: 1 addition & 1 deletion doc/txt/nodeset.txt
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ SEE ALSO

``clubak``\(1), ``cluset``\(1), ``clush``\(1), ``groups.conf``\(5).

http://clustershell.readthedocs.org/
https://clustershell.readthedocs.io/

BUG REPORTS
===========
Expand Down
2 changes: 1 addition & 1 deletion lib/ClusterShell/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@
__version_info__ = tuple([ int(_n) for _n in __version__.split('.')])
__date__ = '2025/01/23'
__author__ = 'Stephane Thiell <sthiell@stanford.edu>'
__url__ = 'http://clustershell.readthedocs.org/'
__url__ = 'https://clustershell.readthedocs.io/'