diff options
author | Carlos O'Donell <carlos@redhat.com> | 2020-10-27 20:28:20 -0400 |
---|---|---|
committer | Carlos O'Donell <carlos@redhat.com> | 2020-10-30 13:08:38 -0400 |
commit | d598134bfbffa1dacf61cca667f8eace6cf2516f (patch) | |
tree | 13a6378976684e3afab9e63d3248a0ea600b133a | |
parent | de1a9197af7f67a89f929dcadb8ceca8c3846b1c (diff) | |
download | glibc-d598134bfbffa1dacf61cca667f8eace6cf2516f.tar glibc-d598134bfbffa1dacf61cca667f8eace6cf2516f.tar.gz glibc-d598134bfbffa1dacf61cca667f8eace6cf2516f.tar.bz2 glibc-d598134bfbffa1dacf61cca667f8eace6cf2516f.zip |
Argument Syntax: Use "option", @option, and @command.
Suggested-by: David O'Brien <daobrien@redhat.com>
-rw-r--r-- | manual/startup.texi | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/manual/startup.texi b/manual/startup.texi index 21c48cd037..9bf24123f5 100644 --- a/manual/startup.texi +++ b/manual/startup.texi @@ -125,13 +125,13 @@ Option names are single alphanumeric characters (as for @code{isalnum}; @pxref{Classification of Characters}). @item -Certain options require an argument. For example, the @samp{-o} command -of the @code{ld} command requires an argument---an output file name. +Certain options require an argument. For example, the @option{-o} option +of the @command{ld} command requires an argument---an output file name. @item An option and its argument may or may not appear as separate tokens. (In other words, the whitespace separating them is optional.) Thus, -@w{@samp{-o foo}} and @samp{-ofoo} are equivalent. +@w{@option{-o foo}} and @option{-ofoo} are equivalent. @item Options typically precede other non-option arguments. @@ -146,7 +146,7 @@ it, define the @code{_POSIX_OPTION_ORDER} environment variable. @xref{Standard Environment}. @item -The argument @samp{--} terminates all options; any following arguments +The argument @option{--} terminates all options; any following arguments are treated as non-option arguments, even if they begin with a hyphen. @item @@ -161,13 +161,13 @@ interpretation is left up to the particular application program. @cindex long-named options GNU adds @dfn{long options} to these conventions. Long options consist -of @samp{--} followed by a name made of alphanumeric characters and +of @option{--} followed by a name made of alphanumeric characters and dashes. Option names are typically one to three words long, with hyphens to separate words. Users can abbreviate the option names as long as the abbreviations are unique. To specify an argument for a long option, write -@samp{--@var{name}=@var{value}}. This syntax enables a long option to +@option{--@var{name}=@var{value}}. This syntax enables a long option to accept an argument that is itself optional. Eventually, @gnusystems{} will provide completion for long option names |