Util-Linux package development
 help / color / mirror / Atom feed
From: Benno Schulenberg <bensberg@telfort.nl>
To: util-linux@vger.kernel.org
Subject: [PATCH 6/8] docs: add -h/--help and -V/--version to three man pages that lacked them
Date: Mon, 14 Apr 2025 11:45:32 +0200	[thread overview]
Message-ID: <20250414094534.9504-6-bensberg@telfort.nl> (raw)
In-Reply-To: <20250414094534.9504-1-bensberg@telfort.nl>

Also, harmonize the wording and placement of these options in
a few other man pages, and use an `include` where possible.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---
 disk-utils/fsck.8.adoc     | 2 +-
 disk-utils/sfdisk.8.adoc   | 6 +++---
 misc-utils/kill.1.adoc     | 2 ++
 misc-utils/lastlog2.8.adoc | 8 ++++----
 sys-utils/blkpr.8.adoc     | 6 +-----
 sys-utils/setsid.1.adoc    | 6 +-----
 sys-utils/tunelp.8.adoc    | 2 ++
 text-utils/line.1.adoc     | 6 +++++-
 8 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/disk-utils/fsck.8.adoc b/disk-utils/fsck.8.adoc
index bf6a0ec26..8631bcd79 100644
--- a/disk-utils/fsck.8.adoc
+++ b/disk-utils/fsck.8.adoc
@@ -113,7 +113,7 @@ Produce verbose output, including all filesystem-specific commands that are exec
 Display help text and exit.
 
 *--version*::
-Display version information and exit.
+Display version and exit.
 
 == FILESYSTEM SPECIFIC OPTIONS
 
diff --git a/disk-utils/sfdisk.8.adoc b/disk-utils/sfdisk.8.adoc
index 0bd04ba3e..d61a031c2 100644
--- a/disk-utils/sfdisk.8.adoc
+++ b/disk-utils/sfdisk.8.adoc
@@ -226,12 +226,12 @@ Wipe filesystem, RAID and partition-table signatures from the device, in order t
 *-W*, *--wipe-partitions* _when_::
 Wipe filesystem, RAID and partition-table signatures from a newly created partition, in order to avoid possible collisions. The argument _when_ can be *auto*, *never* or *always*. When this option is not given, the default is *auto*, in which case signatures are wiped only when in interactive mode and after confirmation by user. In all cases detected signatures are reported by warning messages after a new partition is created. See also *wipefs*(8) command.
 
-*-v*, *--version*::
-Display version information and exit.
-
 *-h*, *--help*::
 Display help text and exit.
 
+*-v*, *--version*::
+Display version and exit.
+
 == INPUT FORMATS
 
 *sfdisk* supports two input formats and generic header lines.
diff --git a/misc-utils/kill.1.adoc b/misc-utils/kill.1.adoc
index 5421fe16f..76027fb52 100644
--- a/misc-utils/kill.1.adoc
+++ b/misc-utils/kill.1.adoc
@@ -104,6 +104,8 @@ Ignored: TERM TSTP TTIN TTOU
 Caught: HUP INT PIPE ALRM CHLD WINCH
 ....
 
+include::man-common/help-version.adoc[]
+
 == EXIT STATUS
 
 *kill* has the following exit status values:
diff --git a/misc-utils/lastlog2.8.adoc b/misc-utils/lastlog2.8.adoc
index 5e3289db7..fb0cf52c9 100644
--- a/misc-utils/lastlog2.8.adoc
+++ b/misc-utils/lastlog2.8.adoc
@@ -44,9 +44,6 @@ Clear last login record of a user. This option can be used only together with
 *-d*, *--database _FILE_::
 Use _FILE_ as lastlog2 database.
 
-*-h*, *--help*::
-Display help message and exit.
-
 *-i*, *--import* _FILE_::
 Import data from old lastlog file _FILE_. Existing entries in the lastlog2
 database will be overwritten.
@@ -67,8 +64,11 @@ Print only last login records more recent than _DAYS_.
 *-u*, *--users* _LOGINS_::
 Print only the last login record of the user _LOGIN_.
 
+*-h*, *--help*::
+Display help text and exit.
+
 *-v*, *--version*::
-Print version number and exit.
+Display version and exit.
 
 If the user has never logged in the message **Never logged in** will be displayed
 in the latest login time row.
diff --git a/sys-utils/blkpr.8.adoc b/sys-utils/blkpr.8.adoc
index db2b8a0a9..98983b779 100644
--- a/sys-utils/blkpr.8.adoc
+++ b/sys-utils/blkpr.8.adoc
@@ -40,11 +40,7 @@ Supported flag is *ignore-key*.
 Supported types are *write-exclusive*, *exclusive-access*, *write-exclusive-reg-only*,
 *exclusive-access-reg-only*, *write-exclusive-all-regs*, and *exclusive-access-all-regs*.
 
-*-V*, *--version*::
-Display version information and exit.
-
-*-h*, *--help*::
-Display help text and exit.
+include::man-common/help-version.adoc[]
 
 == AUTHORS
 
diff --git a/sys-utils/setsid.1.adoc b/sys-utils/setsid.1.adoc
index 3eddcab79..5cf49a597 100644
--- a/sys-utils/setsid.1.adoc
+++ b/sys-utils/setsid.1.adoc
@@ -31,11 +31,7 @@ Always create a new process.
 *-w*, *--wait*::
 Wait for the execution of the program to end, and return the exit status of this program as the exit status of *setsid*.
 
-*-V*, *--version*::
-Display version information and exit.
-
-*-h*, *--help*::
-Display help text and exit.
+include::man-common/help-version.adoc[]
 
 == AUTHORS
 
diff --git a/sys-utils/tunelp.8.adoc b/sys-utils/tunelp.8.adoc
index 37140b31f..c2787889d 100644
--- a/sys-utils/tunelp.8.adoc
+++ b/sys-utils/tunelp.8.adoc
@@ -56,6 +56,8 @@ This option resets the port. It requires a Linux kernel version of 1.1.80 or lat
 *-q*, *--print-irq* _<on|off>_::
 This option sets printing the display of the current IRQ setting.
 
+include::man-common/help-version.adoc[]
+
 == FILES
 
 _/dev/lp?_,
diff --git a/text-utils/line.1.adoc b/text-utils/line.1.adoc
index bed0d0d31..5ad85812d 100644
--- a/text-utils/line.1.adoc
+++ b/text-utils/line.1.adoc
@@ -17,12 +17,16 @@ line - read one line
 
 == SYNOPSIS
 
-*line*
+*line* [*-h*|*-V*]
 
 == DESCRIPTION
 
 The utility *line* copies one line (up to a newline) from standard input to standard output. It always prints at least a newline and returns an exit status of 1 on EOF or read error.
 
+== OPTIONS
+
+include::man-common/help-version.adoc[]
+
 == SEE ALSO
 
 *read*(1p)
-- 
2.48.1


  parent reply	other threads:[~2025-04-14  9:46 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-14  9:45 [PATCH 1/8] docs: rewrite the description of --bytes, to be clearer Benno Schulenberg
2025-04-14  9:45 ` [PATCH 2/8] docs: improve and harmonize the description of -H / --list-columns Benno Schulenberg
2025-04-14  9:45 ` [PATCH 3/8] docs: fix a few indentation issues Benno Schulenberg
2025-04-14  9:45 ` [PATCH 4/8] agetty,setterm: (man) remove the mistakenly added -h and -V short options Benno Schulenberg
2025-04-14  9:45 ` [PATCH 5/8] losetup,lscpu: (man) add the missing -h/--help and -V/--version options Benno Schulenberg
2025-04-14  9:45 ` Benno Schulenberg [this message]
2025-04-14  9:45 ` [PATCH 7/8] lastlog2: (man) fix some broken markup, and lowercase option arguments Benno Schulenberg
2025-04-14  9:45 ` [PATCH 8/8] lastlog2: besides -v, recognize also the standard -V for --version Benno Schulenberg
2025-04-16  8:23 ` [PATCH 1/8] docs: rewrite the description of --bytes, to be clearer Karel Zak

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250414094534.9504-6-bensberg@telfort.nl \
    --to=bensberg@telfort.nl \
    --cc=util-linux@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox