Bug#660106: hostname: [PATCH] improve cmd line --help and simplify manpage SYNOPSIS
February 16th, 2012 - 08:10 am ET by Jari Aalto | Report spam
This is a multi-part MIME message sent by reportbug.
MIME-Version: 1.0
Package: hostname
Version: 3.10
Severity: wishlist
I'm suggestion following minor updates:
- Output cmd line help in alhabetical order
- Simplify SYNOPSIS. The options are best explained in OPTTIONS sections.
- Mirror *.1.fr to that of *.1 for SYNOPSIS.
Debian Release: wheezy/sid
APT prefers unstable
APT policy: (500, 'unstable')
Architecture: i386 (i686)
Kernel: Linux 3.2.0-1-686-pae (SMP w/1 CPU core)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Versions of packages hostname depends on:
ii libc6 2.13-26
hostname recommends no packages.
hostname suggests no packages.
MIME-Version: 1.0
filename="0002-hostname.1-Simplify-SYNOPSIS.patch"
From: Jari Aalto <jari.aalto@cante.net>
Date: Thu, 16 Feb 2012 02:48:28 -0500
Subject: [PATCH 2/3] hostname.1: Simplify SYNOPSIS
Organization: Private
Signed-off-by: Jari Aalto <jari.aalto@cante.net>
hostname.1 | 32 +++++
1 files changed, 5 insertions(+), 27 deletions(-)
diff --git a/hostname.1 b/hostname.1
index c80dbd3..a3d03f9 100644
a/hostname.1
+++ b/hostname.1
@@ -14,40 +14,18 @@ dnsdomainname \- show the system's DNS domain name
.SH SYNOPSIS
.B hostname
-.RB [ \-v ]
-.RB [ \-a ]
-.RB [ \-\-alias ]
-.RB [ \-d ]
-.RB [ \-\-domain ]
-.RB [ \-f ]
-.RB [ \-\-fqdn ]
-.RB [ \-A ]
-.RB [ \-\-all-fqdns ]
-.RB [ \-i ]
-.RB [ \-\-ip-address ]
-.RB [ \-I ]
-.RB [ \-\-all-ip-addresses ]
-.RB [ \-\-long ]
-.RB [ \-s ]
-.RB [ \-\-short ]
-.RB [ \-y ]
-.RB [ \-\-yp ]
-.RB [ \-\-nis ]
+.RB [ options ]
.br
.B hostname
.RB [ \-v ]
-.RB [ \-b ]
-.RB [ \-\-boot ]
-.RB [ \-F\ filename ]
-.RB [ \-\-file\ filename ]
+.RB [ \-b|\-\-boot ]
+.RB [ \-F|--file\ filename ]
.RB [ hostname ]
.br
.B hostname
.RB [ \-v ]
-.RB [ \-h ]
-.RB [ \-\-help ]
-.RB [ \-V ]
-.RB [ \-\-version ]
+.RB [ \-h|\-\-help ]
+.RB [ \-V|\-\-version ]
.PP
.B domainname
.RB [ nisdomain ]
1.7.9
MIME-Version: 1.0
filename="0001-hostname.c-usage-Order-items-alphabetically.patch"
From: Jari Aalto <jari.aalto@cante.net>
Date: Thu, 16 Feb 2012 02:44:43 -0500
Subject: [PATCH 1/3] hostname.c: (usage): Order items alphabetically
Organization: Private
Signed-off-by: Jari Aalto <jari.aalto@cante.net>
hostname.c | 16 ++++++++--
1 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/hostname.c b/hostname.c
index 3ff164a..36f4878 100644
a/hostname.c
+++ b/hostname.c
@@ -3,7 +3,7 @@
* that maintains the host name and the domain name. It
* is also used to show the FQDN and the IP-Addresses.
*
- * Usage: hostname [-d|-f|-s|-a|-i|-y|-A|-I]
+ * Usage: hostname [-a|-A|-d|-f|-i|-I|-s|-y]
* hostname [-h|-V]
* hostname [-b] {name|-F file}
* dnsdomainname
@@ -147,7 +147,7 @@ usage(FILE *stream)
{
fprintf(stream,
"Usage: hostname [-v] [-b] {hostname|-F file} set host name (from file)"
- " hostname [-v] [-d|-f|-s|-a|-i|-y|-A|-I] display formatted name"
+ " hostname [-v] [-a|-A|-d|-f|-i|-I|-s|-y] display formatted name"
" hostname [-v] display host name"
""
" {yp,nis,}domainname [-v] {nisdomain|-F file} set NIS domain name (from file)"
@@ -162,16 +162,16 @@ usage(FILE *stream)
" dnsdomainname=hostname -d"
""
"Program options:"
- " -s, --short short host name"
" -a, --alias alias names"
- " -i, --ip-address addresses for the host name"
- " -I, --all-ip-addresses all addresses for the host"
- " -f, --fqdn, --long long host name (FQDN)"
" -A, --all-fqdns all long host names (FQDNs)"
- " -d, --domain DNS domain name"
- " -y, --yp, --nis NIS/YP domain name"
" -b, --boot set default hostname if none available"
+ " -d, --domain DNS domain name"
+ " -f, --fqdn, --long long host name (FQDN)"
" -F, --file read host name or NIS domain name from given file"
+ " -i, --ip-address addresses for the host name"
+ " -I, --all-ip-addresses all addresses for the host"
+ " -s, --short short host name"
+ " -y, --yp, --nis NIS/YP domain name"
""
"Description:"
" This command can get or set the host name or the NIS domain name. You can"
1.7.9
filename="0003-hostname.1.fr-Simplify-SYNOPSIS.-Sync-with-.1-page.patch"
From: Jari Aalto <jari.aalto@cante.net>
Date: Thu, 16 Feb 2012 02:54:23 -0500
Subject: [PATCH 3/3] hostname.1.fr: Simplify SYNOPSIS. Sync with *.1 page
Organization: Private
Signed-off-by: Jari Aalto <jari.aalto@cante.net>
hostname.1.fr | 22 ++++++++++
1 files changed, 10 insertions(+), 12 deletions(-)
diff --git a/hostname.1.fr b/hostname.1.fr
index da31f87..58b799a 100644
a/hostname.1.fr
+++ b/hostname.1.fr
@@ -5,21 +5,19 @@ hostname \- affiche ou d
dnsdomainname \- affiche le nom de domaine du système
.SH SYNOPSIS
.B hostname
-.RB [ \-d ]
-.RB [ \-\-domain ]
-.RB [ \-F\ nom_de_fichier ]
-.RB [ \-\-file\ nom_de_fichier ]
-.RB [ \-f ]
-.RB [ \-\-fqdn ]
-.RB [ \-h ]
-.RB [ \-\-help ]
-.RB [ \-\-long ]
-.RB [ \-s ]
-.RB [ \-\-short ]
+.RB [ options ]
+.br
+.B hostname
.RB [ \-v ]
-.RB [ \-\-version ]
+.RB [ \-b|\-\-boot ]
+.RB [ \-F|\-\-file\ nom_de_fichier ]
.RB [ nom ]
.br
+.B hostname
+.RB [ \-v ]
+.RB [ \-h|\-\-help ]
+.RB [ \-V|\-\-version ]
+.PP
.B dnsdomainname
.SH DESCRIPTION
.B Hostname
1.7.9
To UNSUBSCRIBE, email to debian-bugs-dist-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
MIME-Version: 1.0
Package: hostname
Version: 3.10
Severity: wishlist
I'm suggestion following minor updates:
- Output cmd line help in alhabetical order
- Simplify SYNOPSIS. The options are best explained in OPTTIONS sections.
- Mirror *.1.fr to that of *.1 for SYNOPSIS.
Debian Release: wheezy/sid
APT prefers unstable
APT policy: (500, 'unstable')
Architecture: i386 (i686)
Kernel: Linux 3.2.0-1-686-pae (SMP w/1 CPU core)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Versions of packages hostname depends on:
ii libc6 2.13-26
hostname recommends no packages.
hostname suggests no packages.
MIME-Version: 1.0
filename="0002-hostname.1-Simplify-SYNOPSIS.patch"
From ce084cf248dd5a937a3f08f33addcdd861ccd548 Mon Sep 17 00:00:00 2001
From: Jari Aalto <jari.aalto@cante.net>
Date: Thu, 16 Feb 2012 02:48:28 -0500
Subject: [PATCH 2/3] hostname.1: Simplify SYNOPSIS
Organization: Private
Signed-off-by: Jari Aalto <jari.aalto@cante.net>
hostname.1 | 32 +++++
1 files changed, 5 insertions(+), 27 deletions(-)
diff --git a/hostname.1 b/hostname.1
index c80dbd3..a3d03f9 100644
a/hostname.1
+++ b/hostname.1
@@ -14,40 +14,18 @@ dnsdomainname \- show the system's DNS domain name
.SH SYNOPSIS
.B hostname
-.RB [ \-v ]
-.RB [ \-a ]
-.RB [ \-\-alias ]
-.RB [ \-d ]
-.RB [ \-\-domain ]
-.RB [ \-f ]
-.RB [ \-\-fqdn ]
-.RB [ \-A ]
-.RB [ \-\-all-fqdns ]
-.RB [ \-i ]
-.RB [ \-\-ip-address ]
-.RB [ \-I ]
-.RB [ \-\-all-ip-addresses ]
-.RB [ \-\-long ]
-.RB [ \-s ]
-.RB [ \-\-short ]
-.RB [ \-y ]
-.RB [ \-\-yp ]
-.RB [ \-\-nis ]
+.RB [ options ]
.br
.B hostname
.RB [ \-v ]
-.RB [ \-b ]
-.RB [ \-\-boot ]
-.RB [ \-F\ filename ]
-.RB [ \-\-file\ filename ]
+.RB [ \-b|\-\-boot ]
+.RB [ \-F|--file\ filename ]
.RB [ hostname ]
.br
.B hostname
.RB [ \-v ]
-.RB [ \-h ]
-.RB [ \-\-help ]
-.RB [ \-V ]
-.RB [ \-\-version ]
+.RB [ \-h|\-\-help ]
+.RB [ \-V|\-\-version ]
.PP
.B domainname
.RB [ nisdomain ]
1.7.9
MIME-Version: 1.0
filename="0001-hostname.c-usage-Order-items-alphabetically.patch"
From c3cf1aec19bc038e8460695a59bea111a5abf926 Mon Sep 17 00:00:00 2001
From: Jari Aalto <jari.aalto@cante.net>
Date: Thu, 16 Feb 2012 02:44:43 -0500
Subject: [PATCH 1/3] hostname.c: (usage): Order items alphabetically
Organization: Private
Signed-off-by: Jari Aalto <jari.aalto@cante.net>
hostname.c | 16 ++++++++--
1 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/hostname.c b/hostname.c
index 3ff164a..36f4878 100644
a/hostname.c
+++ b/hostname.c
@@ -3,7 +3,7 @@
* that maintains the host name and the domain name. It
* is also used to show the FQDN and the IP-Addresses.
*
- * Usage: hostname [-d|-f|-s|-a|-i|-y|-A|-I]
+ * Usage: hostname [-a|-A|-d|-f|-i|-I|-s|-y]
* hostname [-h|-V]
* hostname [-b] {name|-F file}
* dnsdomainname
@@ -147,7 +147,7 @@ usage(FILE *stream)
{
fprintf(stream,
"Usage: hostname [-v] [-b] {hostname|-F file} set host name (from file)"
- " hostname [-v] [-d|-f|-s|-a|-i|-y|-A|-I] display formatted name"
+ " hostname [-v] [-a|-A|-d|-f|-i|-I|-s|-y] display formatted name"
" hostname [-v] display host name"
""
" {yp,nis,}domainname [-v] {nisdomain|-F file} set NIS domain name (from file)"
@@ -162,16 +162,16 @@ usage(FILE *stream)
" dnsdomainname=hostname -d"
""
"Program options:"
- " -s, --short short host name"
" -a, --alias alias names"
- " -i, --ip-address addresses for the host name"
- " -I, --all-ip-addresses all addresses for the host"
- " -f, --fqdn, --long long host name (FQDN)"
" -A, --all-fqdns all long host names (FQDNs)"
- " -d, --domain DNS domain name"
- " -y, --yp, --nis NIS/YP domain name"
" -b, --boot set default hostname if none available"
+ " -d, --domain DNS domain name"
+ " -f, --fqdn, --long long host name (FQDN)"
" -F, --file read host name or NIS domain name from given file"
+ " -i, --ip-address addresses for the host name"
+ " -I, --all-ip-addresses all addresses for the host"
+ " -s, --short short host name"
+ " -y, --yp, --nis NIS/YP domain name"
""
"Description:"
" This command can get or set the host name or the NIS domain name. You can"
1.7.9
filename="0003-hostname.1.fr-Simplify-SYNOPSIS.-Sync-with-.1-page.patch"
From 1c7a188dcb443345f28a8f9bb9c9713d9e81cb06 Mon Sep 17 00:00:00 2001
From: Jari Aalto <jari.aalto@cante.net>
Date: Thu, 16 Feb 2012 02:54:23 -0500
Subject: [PATCH 3/3] hostname.1.fr: Simplify SYNOPSIS. Sync with *.1 page
Organization: Private
Signed-off-by: Jari Aalto <jari.aalto@cante.net>
hostname.1.fr | 22 ++++++++++
1 files changed, 10 insertions(+), 12 deletions(-)
diff --git a/hostname.1.fr b/hostname.1.fr
index da31f87..58b799a 100644
a/hostname.1.fr
+++ b/hostname.1.fr
@@ -5,21 +5,19 @@ hostname \- affiche ou d
dnsdomainname \- affiche le nom de domaine du système
.SH SYNOPSIS
.B hostname
-.RB [ \-d ]
-.RB [ \-\-domain ]
-.RB [ \-F\ nom_de_fichier ]
-.RB [ \-\-file\ nom_de_fichier ]
-.RB [ \-f ]
-.RB [ \-\-fqdn ]
-.RB [ \-h ]
-.RB [ \-\-help ]
-.RB [ \-\-long ]
-.RB [ \-s ]
-.RB [ \-\-short ]
+.RB [ options ]
+.br
+.B hostname
.RB [ \-v ]
-.RB [ \-\-version ]
+.RB [ \-b|\-\-boot ]
+.RB [ \-F|\-\-file\ nom_de_fichier ]
.RB [ nom ]
.br
+.B hostname
+.RB [ \-v ]
+.RB [ \-h|\-\-help ]
+.RB [ \-V|\-\-version ]
+.PP
.B dnsdomainname
.SH DESCRIPTION
.B Hostname
1.7.9
To UNSUBSCRIBE, email to debian-bugs-dist-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Similar topics
- [PATCH v2] perf record: fix symbol processing bug and greatly improve performance
- [PATCH] perf: fix symbol processing bug and greatly improve performance
Make your own search :
Tags
Create a new topic
Follow the discussion
1 reply
Make a reply
June 19th, 2013 - 2:29 PM ET
Join now


Replies