Skip to content
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.

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

Fix users.rst #42

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
12 changes: 5 additions & 7 deletions docs/users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,29 +53,27 @@ text file (this means you can view the information by using *cat* command.)
tss:x:59:59:Account used by the trousers package to sandbox the tcsd daemon:/dev/null:/sbin/nologin


Each line has seven entries separated by *:*.

::
Each line has seven entries separated by::
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is missing the vital : part, which is the separator.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For Sphinx below two things are same:

Each line has seven entries separated by::
Each line has seven entries separated by:

::

When we generate output, Sphinx will automatically expands ending ::, with : followed by a :: code-directive, see below screenshot. In output, we're still getting a : at the end of sentence.

users


username:password:uid:gid:gecos:/home/dirname:shell

+---------------+---------------------------------+
| FIELD | MEANING |
+===============+=================================+
| username | the username |
| username | The username |
+---------------+---------------------------------+
| password | the password of the user |
| password | The password of the user |
+---------------+---------------------------------+
| uid | Numeric user id |
+---------------+---------------------------------+
| gid | Numeric group id of user |
+---------------+---------------------------------+
| gecos | arbitary field |
| gecos | Arbitrary field |
+---------------+---------------------------------+
| /home/dirname | Home directory of the user |
+---------------+---------------------------------+
| shell | Which shell to use for the user |
+--------------+----------------------------------+
+---------------+---------------------------------+

You’ll see accounts with */sbin/nologin* as their shell. These are generally
accounts for various services, which are not supposed to be used by a normal
Expand Down