Re: -i interactive command not working

[Alfred M. Szmidt]

   But I'm sure there are plenty of other duplicate descriptions that
   _should_ be factored.  Any such patch would be very welcome.

I took a quick look, and the obvious things to factor are the
descriptions for the common switches.  But I'm unsure if it is really
worth the effort, a lot of the programs have similar options, but they
all differ in some small detail.  Like -i/--interactive example you
gave.  Anyway, patch and ChangeLog applied.  Note that it only
"macrofies" <10 options.

   > @macro opt_interactive

   btw, TeX macro names can't contain `_'.

Bah, crazy little language.


If someone could double check the ChangeLog then that would be great,
since I'm starting to get the nice side effects of being up all
night...

Index: doc/ChangeLog
2004-01-09  Alfred M. Szmidt  <address@hidden>

        * coreutils.texi: Include `options.texi'
        (What information is listed): Use macro to describe
        `--human-readable' (-h).
        (cp invocation): Use macros to descibre
        `--strip-trailing-slashes', --suffix' (-S),
        `--target-directory', and `--version-control' (-V).
        (install invocation): Use macros to descibre `--backup' (-b),
        `--suffix' (-S), `--target-directory', and `--version-control'
        (-V).
        (mv invocation): Use macros to descibre `--backup' (-b),
        `--strip-trailing-slashes', --suffix' (-S),
        `--target-directory', and `--version-control' (-V).
        (ln invocation): Use macros to descibre `--backup' (-b),
        `--suffix' (-S), `--target-directory', and `--version-control'
        (-V).
        (df invocation): Use macros to describe `--human-readable'
        (-h), and `--si' (-H).
        (du invocation): Likewise.

        * options.texi: New file.

Index: doc/coreutils.texi
--- doc/coreutils.texi
+++ doc/coreutils.texi
@@ -7,6 +7,7 @@
 
 @include version.texi
 @include constants.texi
address@hidden options.texi
 
 @c Define new indices.
 @defcodeindex op
@@ -5239,15 +5240,7 @@
 (This is the default in some address@hidden versions of @command{ls}, so we
 provide this option for compatibility.)
 
address@hidden -h
address@hidden --human-readable
address@hidden -h
address@hidden --human-readable
address@hidden human-readable output
-Append a size letter to each size, such as @samp{M} for mebibytes.
-Powers of 1024 are used, not 1000; @samp{M} stands for 1,048,576 bytes.
-This option is equivalent to @option{--block-size=human} (@pxref{Block size}).
-Use the @option{--si} option if you prefer powers of 1000.
address@hidden
 
 @item -i
 @itemx --inode
@@ -6234,11 +6227,7 @@
 since such a file must not have any holes.
 @end table
 
address@hidden @address@hidden
address@hidden --strip-trailing-slashes
address@hidden stripping trailing slashes
-Remove any trailing slashes from each @var{source} argument.
address@hidden slashes}.
address@hidden
 
 @item -s
 @itemx --symbolic-link
@@ -6250,19 +6239,9 @@
 destination files are in the current directory.  This option merely
 results in an error message on systems that do not support symbolic links.
 
address@hidden -S @var{suffix}
address@hidden address@hidden
address@hidden -S
address@hidden --suffix
-Append @var{suffix} to each backup file made with @option{-b}.
address@hidden options}.
address@hidden
 
address@hidden @address@hidden@var{directory}}
address@hidden --target-directory
address@hidden target directory
address@hidden destination directory
-Specify the destination @var{directory}.
address@hidden directory}.
address@hidden
 
 @item -v
 @itemx --verbose
@@ -6270,14 +6249,7 @@
 @opindex --verbose
 Print the name of each file before copying it.
 
address@hidden -V @var{method}
address@hidden address@hidden
address@hidden -V
address@hidden --version-control
-Change the type of backups made with @option{-b}.  The @var{method}
-argument can be @samp{none} (or @samp{off}), @samp{numbered} (or
address@hidden), @samp{existing} (or @samp{nil}), or @samp{never} (or
address@hidden).  @xref{Backup options}.
address@hidden
 
 @item -x
 @itemx --one-file-system
@@ -6492,14 +6464,7 @@
 
 @table @samp
 
address@hidden -b
address@hidden @address@hidden@var{method}]}
address@hidden -b
address@hidden --backup
address@hidden VERSION_CONTROL
address@hidden backups, making
address@hidden options}.
-Make a backup of each file that would otherwise be overwritten or removed.
address@hidden
 
 @item -c
 @opindex -c
@@ -6571,19 +6536,9 @@
 @cindex stripping symbol table information
 Strip the symbol tables from installed binary executables.
 
address@hidden -S @var{suffix}
address@hidden address@hidden
address@hidden -S
address@hidden --suffix
-Append @var{suffix} to each backup file made with @option{-b}.
address@hidden options}.
address@hidden
 
address@hidden @address@hidden@var{directory}}
address@hidden --target-directory
address@hidden target directory
address@hidden destination directory
-Specify the destination @var{directory}.
address@hidden directory}.
address@hidden
 
 @item -v
 @itemx --verbose
@@ -6591,14 +6546,7 @@
 @opindex --verbose
 Print the name of each file before copying it.
 
address@hidden -V @var{method}
address@hidden address@hidden
address@hidden -V
address@hidden --version-control
-Change the type of backups made with @option{-b}.  The @var{method}
-argument can be @samp{none} (or @samp{off}), @samp{numbered} (or
address@hidden), @samp{existing} (or @samp{nil}), or @samp{never} (or
address@hidden).  @xref{Backup options}.
address@hidden
 
 @end table
 
@@ -6651,14 +6599,7 @@
 
 @table @samp
 
address@hidden -b
address@hidden @address@hidden@var{method}]}
address@hidden -b
address@hidden --backup
address@hidden VERSION_CONTROL
address@hidden backups, making
address@hidden options}.
-Make a backup of each file that would otherwise be overwritten or removed.
address@hidden
 
 @item -f
 @itemx --force
@@ -6699,34 +6640,13 @@
 @opindex --verbose
 Print the name of each file before moving it.
 
address@hidden @address@hidden
address@hidden --strip-trailing-slashes
address@hidden stripping trailing slashes
-Remove any trailing slashes from each @var{source} argument.
address@hidden slashes}.
address@hidden
 
address@hidden -S @var{suffix}
address@hidden address@hidden
address@hidden -S
address@hidden --suffix
-Append @var{suffix} to each backup file made with @option{-b}.
address@hidden options}.
address@hidden
 
address@hidden @address@hidden@var{directory}}
address@hidden --target-directory
address@hidden target directory
address@hidden destination directory
-Specify the destination @var{directory}.
address@hidden directory}.
address@hidden
 
address@hidden -V @var{method}
address@hidden address@hidden
address@hidden -V
address@hidden --version-control
-Change the type of backups made with @option{-b}.  The @var{method}
-argument can be @samp{none} (or @samp{off}), @samp{numbered} (or
address@hidden), @samp{existing} (or @samp{nil}), or @samp{never} (or
address@hidden).  @xref{Backup options}.
address@hidden
 
 @end table
 
@@ -7173,14 +7093,7 @@
 
 @table @samp
 
address@hidden -b
address@hidden @address@hidden@var{method}]}
address@hidden -b
address@hidden --backup
address@hidden VERSION_CONTROL
address@hidden backups, making
address@hidden options}.
-Make a backup of each file that would otherwise be overwritten or removed.
address@hidden
 
 @item -d
 @itemx -F
@@ -7231,19 +7144,9 @@
 Make symbolic links instead of hard links.  This option merely produces
 an error message on systems that do not support symbolic links.
 
address@hidden -S @var{suffix}
address@hidden address@hidden
address@hidden -S
address@hidden --suffix
-Append @var{suffix} to each backup file made with @option{-b}.
address@hidden options}.
address@hidden
 
address@hidden @address@hidden@var{directory}}
address@hidden --target-directory
address@hidden target directory
address@hidden destination directory
-Specify the destination @var{directory}.
address@hidden directory}.
address@hidden
 
 @item -v
 @itemx --verbose
@@ -7251,14 +7154,7 @@
 @opindex --verbose
 Print the name of each file before linking it.
 
address@hidden -V @var{method}
address@hidden address@hidden
address@hidden -V
address@hidden --version-control
-Change the type of backups made with @option{-b}.  The @var{method}
-argument can be @samp{none} (or @samp{off}), @samp{numbered} (or
address@hidden), @samp{existing} (or @samp{nil}), or @samp{never} (or
address@hidden).  @xref{Backup options}.
address@hidden
 
 @end table
 
@@ -8163,24 +8059,9 @@
 Scale sizes by @var{size} before printing them (@pxref{Block size}).
 For example, @option{-BG} prints sizes in units of 1,073,741,824 bytes.
 
address@hidden -h
address@hidden --human-readable
address@hidden -h
address@hidden --human-readable
address@hidden human-readable output
-Append a size letter to each size, such as @samp{M} for mebibytes.
-Powers of 1024 are used, not 1000; @samp{M} stands for 1,048,576 bytes.
-Use the @option{-H} or @option{--si} option if you prefer powers of 1000.
address@hidden
 
address@hidden -H
address@hidden --si
address@hidden -H
address@hidden --si
address@hidden SI output
-Append an SI-style abbreviation to each size, such as @samp{MB} for
-megabytes.  Powers of 1000 are used, not 1024; @samp{MB} stands for
-1,000,000 bytes.  Use the @option{-h} or @option{--human-readable} option if
-you prefer powers of 1024.
address@hidden
 
 @item -i
 @itemx --inodes
@@ -8389,24 +8270,9 @@
 out the disk usage of directories, such as @file{/usr/tmp}, which
 are often symbolic links.
 
address@hidden -h
address@hidden --human-readable
address@hidden -h
address@hidden --human-readable
address@hidden human-readable output
-Append a size letter to each size, such as @samp{M} for mebibytes.
-Powers of 1024 are used, not 1000; @samp{M} stands for 1,048,576 bytes.
-Use the @option{-H} or @option{--si} option if you prefer powers of 1000.
address@hidden
 
address@hidden -H
address@hidden --si
address@hidden -H
address@hidden --si
address@hidden SI output
-Append an SI-style abbreviation to each size, such as @samp{MB} for
-megabytes.  Powers of 1000 are used, not 1024; @samp{MB} stands for
-1,000,000 bytes.  Use the @option{-h} or @option{--human-readable} option if
-you prefer powers of 1024.
address@hidden
 
 @item -k
 @opindex -k
Index: doc/options.texi
--- /dev/null
+++ doc/options.texi
@@ -0,0 +1,70 @@
address@hidden optBackup
address@hidden -b
address@hidden @address@hidden@var{method}]}
address@hidden -b
address@hidden --backup
address@hidden VERSION_CONTROL
address@hidden backups, making
address@hidden options}.
+Make a backup of each file that would otherwise be overwritten or removed.
address@hidden macro
+
address@hidden optAppendBackupSuffix
address@hidden -S @var{suffix}
address@hidden address@hidden
address@hidden -S
address@hidden --suffix
+Append @var{suffix} to each backup file made with @option{-b}.
address@hidden options}.
address@hidden macro
+
address@hidden optTargetDirectory
address@hidden @address@hidden@var{directory}}
address@hidden --target-directory
address@hidden target directory
address@hidden destination directory
+Specify the destination @var{directory}.
address@hidden directory}.
address@hidden macro
+
address@hidden optSi
address@hidden -H
address@hidden --si
address@hidden -H
address@hidden --si
address@hidden SI output
+Append an SI-style abbreviation to each size, such as @samp{MB} for
+megabytes.  Powers of 1000 are used, not 1024; @samp{MB} stands for
+1,000,000 bytes.  Use the @option{-h} or @option{--human-readable} option if
+you prefer powers of 1024.
address@hidden macro
+
address@hidden optHumanReadable
address@hidden -h
address@hidden --human-readable
address@hidden -h
address@hidden --human-readable
address@hidden human-readable output
+Append a size letter to each size, such as @samp{M} for mebibytes.
+Powers of 1024 are used, not 1000; @samp{M} stands for 1,048,576 bytes.
+Use the @option{-H} or @option{--si} option if you prefer powers of 1000.
address@hidden macro
+
address@hidden optStripTrailingSlashes
address@hidden @address@hidden
address@hidden --strip-trailing-slashes
address@hidden stripping trailing slashes
+Remove any trailing slashes from each @var{source} argument.
address@hidden slashes}.
address@hidden macro
+
address@hidden optVersionControl
address@hidden -V @var{method}
address@hidden address@hidden
address@hidden -V
address@hidden --version-control
+Change the type of backups made with @option{-b}.  The @var{method}
+argument can be @samp{none} (or @samp{off}), @samp{numbered} (or
address@hidden), @samp{existing} (or @samp{nil}), or @samp{never} (or
address@hidden).  @xref{Backup options}.
address@hidden macro