From: Alexander Duyck <alexander.h.duyck@intel•com>
To: bhutchings@solarflare•com
Cc: netdev@vger•kernel.org
Subject: [ethtool PATCH 1/2] Add macro for displaying [value N] formatting to manpage
Date: Thu, 10 Feb 2011 17:18:33 -0800 [thread overview]
Message-ID: <20110211011833.23554.32698.stgit@gitlad.jf.intel.com> (raw)
In-Reply-To: <20110211010806.23554.98333.stgit@gitlad.jf.intel.com>
This change adds a macro for displaying optional values that take a numeric
value to the manpage.
Signed-off-by: Alexander Duyck <alexander.h.duyck@intel•com>
---
ethtool.8.in | 102 ++++++++++++++++++++++------------------------------------
1 files changed, 38 insertions(+), 64 deletions(-)
diff --git a/ethtool.8.in b/ethtool.8.in
index 0ee91a0..133825b 100644
--- a/ethtool.8.in
+++ b/ethtool.8.in
@@ -34,6 +34,12 @@
[\\fB\\$1\\fP\ \\fB\\$2\\fP|\\fB\\$3\\fP|\\fB\\$4\\fP|\\fB\\$5\\fP]
..
.\"
+.\" .BN - value with a numeric input as in "[value N]"
+.\"
+.de BN
+[\\fB\\$1\\fP\ \\fIN\\fP]
+..
+.\"
.\" \(*MA - mac address
.\"
.ds MA \fIxx\fP\fB:\fP\fIyy\fP\fB:\fP\fIzz\fP\fB:\fP\fIaa\fP\fB:\fP\fIbb\fP\fB:\fP\fIcc\fP
@@ -110,60 +116,36 @@ ethtool \- query or control network driver and hardware settings
.I ethX
.B2 adaptive-rx on off
.B2 adaptive-tx on off
-.RB [ rx-usecs
-.IR N ]
-.RB [ rx-frames
-.IR N ]
-.RB [ rx-usecs-irq
-.IR N ]
-.RB [ rx-frames-irq
-.IR N ]
-.RB [ tx-usecs
-.IR N ]
-.RB [ tx-frames
-.IR N ]
-.RB [ tx-usecs-irq
-.IR N ]
-.RB [ tx-frames-irq
-.IR N ]
-.RB [ stats-block-usecs
-.IR N ]
-.RB [ pkt-rate-low
-.IR N ]
-.RB [ rx-usecs-low
-.IR N ]
-.RB [ rx-frames-low
-.IR N ]
-.RB [ tx-usecs-low
-.IR N ]
-.RB [ tx-frames-low
-.IR N ]
-.RB [ pkt-rate-high
-.IR N ]
-.RB [ rx-usecs-high
-.IR N ]
-.RB [ rx-frames-high
-.IR N ]
-.RB [ tx-usecs-high
-.IR N ]
-.RB [ tx-frames-high
-.IR N ]
-.RB [ sample-interval
-.IR N ]
+.BN rx-usecs
+.BN rx-frames
+.BN rx-usecs-irq
+.BN rx-frames-irq
+.BN tx-usecs
+.BN tx-frames
+.BN tx-usecs-irq
+.BN tx-frames-irq
+.BN stats-block-usecs
+.BN pkt-rate-low
+.BN rx-usecs-low
+.BN rx-frames-low
+.BN tx-usecs-low
+.BN tx-frames-low
+.BN pkt-rate-high
+.BN rx-usecs-high
+.BN rx-frames-high
+.BN tx-usecs-high
+.BN tx-frames-high
+.BN sample-interval
.B ethtool \-g|\-\-show\-ring
.I ethX
.B ethtool \-G|\-\-set\-ring
.I ethX
-.RB [ rx
-.IR N ]
-.RB [ rx-mini
-.IR N ]
-.RB [ rx-jumbo
-.IR N ]
-.RB [ tx
-.IR N ]
+.BN rx
+.BN rx-mini
+.BN rx-jumbo
+.BN tx
.B ethtool \-i|\-\-driver
.I ethX
@@ -178,21 +160,15 @@ ethtool \- query or control network driver and hardware settings
.B ethtool \-e|\-\-eeprom\-dump
.I ethX
.B2 raw on off
-.RB [ offset
-.IR N ]
-.RB [ length
-.IR N ]
+.BN offset
+.BN length
.B ethtool \-E|\-\-change\-eeprom
.I ethX
-.RB [ magic
-.IR N ]
-.RB [ offset
-.IR N ]
-.RB [ length
-.IR N ]
-.RB [ value
-.IR N ]
+.BN magic
+.BN offset
+.BN length
+.BN value
.B ethtool \-k|\-\-show\-offload
.I ethX
@@ -234,10 +210,8 @@ ethtool \- query or control network driver and hardware settings
.B2 duplex half full
.B4 port tp aui bnc mii fibre
.B2 autoneg on off
-.RB [ advertise
-.IR N ]
-.RB [ phyad
-.IR N ]
+.BN advertise
+.BN phyad
.B2 xcvr internal external
.RB [ wol \ \*(WO]
.RB [ sopass \ \*(MA]
next prev parent reply other threads:[~2011-02-11 1:18 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-02-11 1:18 [ethtool PATCH 0/2] Add support for RX network flow classifier rules Alexander Duyck
2011-02-11 1:18 ` Alexander Duyck [this message]
2011-02-21 14:45 ` [ethtool PATCH 1/2] Add macro for displaying [value N] formatting to manpage Ben Hutchings
2011-02-11 1:18 ` [ethtool PATCH 2/2] Add RX packet classification interface Alexander Duyck
2011-02-21 15:40 ` Ben Hutchings
2011-02-22 20:52 ` Alexander Duyck
2011-03-01 0:35 ` Ben Hutchings
2011-03-04 19:09 ` Alexander Duyck
2011-03-07 15:57 ` Ben Hutchings
2011-03-07 17:04 ` Alexander Duyck
2011-03-07 17:57 ` Ben Hutchings
2011-03-07 18:22 ` Dimitris Michailidis
2011-03-07 18:28 ` Ben Hutchings
2011-03-07 18:43 ` Alexander Duyck
2011-03-07 18:57 ` Dimitris Michailidis
2011-03-07 19:00 ` Ben Hutchings
2011-03-07 19:11 ` Dimitris Michailidis
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=20110211011833.23554.32698.stgit@gitlad.jf.intel.com \
--to=alexander.h.duyck@intel$(echo .)com \
--cc=bhutchings@solarflare$(echo .)com \
--cc=netdev@vger$(echo .)kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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