1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-22 05:31:01 -08:00

Use recommended long options syntax in man page

* doc/man/emacs.1.in: Specify equals sign for long options, as
recommended in the manual.
This commit is contained in:
Philipp Stephani 2018-01-08 00:11:16 +01:00
parent c433e873cf
commit 779b2ac484

View file

@ -61,7 +61,7 @@ The following options are of general interest:
Edit Edit
.IR file . .IR file .
.TP .TP
.BI \-\-file " file\fR,\fP " \-\-find-file " file\fR,\fP " \-\-visit " file" .BI \-\-file= "file\fR,\fP " \-\-find-file= "file\fR,\fP " \-\-visit= "file"
The same as specifying The same as specifying
.I file .I file
directly as an argument. directly as an argument.
@ -79,7 +79,7 @@ Go to the specified
and and
.IR column . .IR column .
.TP .TP
.BI \-\-chdir " directory" .BI \-\-chdir= "directory"
Change to Change to
.IR directory . .IR directory .
.TP .TP
@ -112,12 +112,12 @@ Lisp debugger during the processing of the user init file
.BR ~/.emacs . .BR ~/.emacs .
This is useful for debugging problems in the init file. This is useful for debugging problems in the init file.
.TP .TP
.BI \-u " user\fR,\fP " \-\-user " user" .BI \-u " user\fR,\fP " \-\-user= "user"
Load Load
.IR user 's .IR user 's
init file. init file.
.TP .TP
.BI \-t " file\fR,\fP " \-\-terminal " file" .BI \-t " file\fR,\fP " \-\-terminal= "file"
Use specified Use specified
.I file .I file
as the terminal instead of using stdin/stdout. as the terminal instead of using stdin/stdout.
@ -144,15 +144,15 @@ The following options are Lisp-oriented
(these options are processed in the order encountered): (these options are processed in the order encountered):
.RS .RS
.TP 8 .TP 8
.BI \-f " function\fR,\fP " \-\-funcall " function" .BI \-f " function\fR,\fP " \-\-funcall= "function"
Execute the lisp function Execute the lisp function
.IR function . .IR function .
.TP .TP
.BI \-l " file\fR,\fP " \-\-load " file" .BI \-l " file\fR,\fP " \-\-load= "file"
Load the lisp code in the file Load the lisp code in the file
.IR file . .IR file .
.TP .TP
.BI \-\-eval " expr\fR,\fP " \-\-execute " expr" .BI \-\-eval= "expr\fR,\fP " \-\-execute= "expr"
Evaluate the Lisp expression Evaluate the Lisp expression
.IR expr . .IR expr .
.RE .RE
@ -168,12 +168,12 @@ The editor will send messages to stderr.
You must use \-l and \-f options to specify files to execute You must use \-l and \-f options to specify files to execute
and functions to call. and functions to call.
.TP .TP
.BI \-\-script " file" .BI \-\-script= "file"
Run Run
.I file .I file
as an Emacs Lisp script. as an Emacs Lisp script.
.TP .TP
.BI \-\-insert " file" .BI \-\-insert= "file"
Insert contents of Insert contents of
.I file .I file
into the current buffer. into the current buffer.
@ -183,7 +183,7 @@ Exit
.I Emacs .I Emacs
while in batch mode. while in batch mode.
.TP .TP
.BI \-L " dir\fR,\fP " \-\-directory " dir" .BI \-L " dir\fR,\fP " \-\-directory= "dir"
Add Add
.I dir .I dir
to the list of directories to the list of directories
@ -206,13 +206,13 @@ process so that you can continue using your original window.
can be started with the following X switches: can be started with the following X switches:
.RS .RS
.TP 8 .TP 8
.BI \-\-name " name" .BI \-\-name= "name"
Specify the name which should be assigned to the initial Specify the name which should be assigned to the initial
.I Emacs .I Emacs
window. window.
This controls looking up X resources as well as the window title. This controls looking up X resources as well as the window title.
.TP .TP
.BI \-T " name\fR,\fP " \-\-title " name" .BI \-T " name\fR,\fP " \-\-title= "name"
Specify the title for the initial X window. Specify the title for the initial X window.
.TP .TP
.BR \-r ", " \-rv ", " \-\-reverse\-video .BR \-r ", " \-rv ", " \-\-reverse\-video
@ -220,7 +220,7 @@ Display the
.I Emacs .I Emacs
window in reverse video. window in reverse video.
.TP .TP
.BI \-fn " font\fR,\fP " \-\-font " font" .BI \-fn " font\fR,\fP " \-\-font= "font"
Set the Set the
.I Emacs .I Emacs
window's font to that specified by window's font to that specified by
@ -247,7 +247,7 @@ for more information.
When you specify a font, be sure to put a space between the When you specify a font, be sure to put a space between the
switch and the font name. switch and the font name.
.TP .TP
.BI \-\-xrm " resources" .BI \-\-xrm= "resources"
Set additional X resources. Set additional X resources.
.TP .TP
.BI "\-\-color\fR,\fP \-\-color=" mode .BI "\-\-color\fR,\fP \-\-color=" mode
@ -256,20 +256,20 @@ Override color mode for character terminals;
defaults to "auto", and can also be "never", "auto", "always", defaults to "auto", and can also be "never", "auto", "always",
or a mode name like "ansi8". or a mode name like "ansi8".
.TP .TP
.BI \-bw " pixels\fR,\fP " \-\-border\-width " pixels" .BI \-bw " pixels\fR,\fP " \-\-border\-width= "pixels"
Set the Set the
.I Emacs .I Emacs
window's border width to the number of pixels specified by window's border width to the number of pixels specified by
.IR pixels . .IR pixels .
Defaults to one pixel on each side of the window. Defaults to one pixel on each side of the window.
.TP .TP
.BI \-ib " pixels\fR,\fP " \-\-internal\-border " pixels" .BI \-ib " pixels\fR,\fP " \-\-internal\-border= "pixels"
Set the window's internal border width to the number of pixels specified Set the window's internal border width to the number of pixels specified
by by
.IR pixels . .IR pixels .
Defaults to one pixel of padding on each side of the window. Defaults to one pixel of padding on each side of the window.
.TP .TP
.BI \-g " geometry\fR,\fP " \-\-geometry " geometry" .BI \-g " geometry\fR,\fP " \-\-geometry= "geometry"
Set the Set the
.I Emacs .I Emacs
window's width, height, and position as specified. window's width, height, and position as specified.
@ -282,7 +282,7 @@ See the Emacs manual, section "Options for Window Size and Position",
for information on how window sizes interact for information on how window sizes interact
with selecting or deselecting the tool bar and menu bar. with selecting or deselecting the tool bar and menu bar.
.TP .TP
.BI \-lsp " pixels\fR,\fP " \-\-line\-spacing " pixels" .BI \-lsp " pixels\fR,\fP " \-\-line\-spacing= "pixels"
Additional space to put between lines. Additional space to put between lines.
.TP .TP
.BR \-vb ", " \-\-vertical\-scroll\-bars .BR \-vb ", " \-\-vertical\-scroll\-bars
@ -300,26 +300,26 @@ Make the first frame as wide as the screen.
.BR \-mm ", " \-\-maximized .BR \-mm ", " \-\-maximized
Maximize the first frame, like "\-fw \-fh". Maximize the first frame, like "\-fw \-fh".
.TP .TP
.BI \-fg " color\fR,\fP " \-\-foreground\-color " color" .BI \-fg " color\fR,\fP " \-\-foreground\-color= "color"
On color displays, set the color of the text. On color displays, set the color of the text.
Use the command Use the command
.I M\-x list\-colors\-display .I M\-x list\-colors\-display
for a list of valid color names. for a list of valid color names.
.TP .TP
.BI \-bg " color\fR,\fP " \-\-background\-color " color" .BI \-bg " color\fR,\fP " \-\-background\-color= "color"
On color displays, set the color of the window's background. On color displays, set the color of the window's background.
.TP .TP
.BI \-bd " color\fR,\fP " \-\-border\-color " color" .BI \-bd " color\fR,\fP " \-\-border\-color= "color"
On color displays, set the color of the window's border. On color displays, set the color of the window's border.
.TP .TP
.BI \-cr " color\fR,\fP " \-\-cursor\-color " color" .BI \-cr " color\fR,\fP " \-\-cursor\-color= "color"
On color displays, set the color of the window's text cursor. On color displays, set the color of the window's text cursor.
.TP .TP
.BI \-ms " color\fR,\fP " \-\-mouse\-color " color" .BI \-ms " color\fR,\fP " \-\-mouse\-color= "color"
On color displays, set the color of the window's mouse cursor. On color displays, set the color of the window's mouse cursor.
.TP .TP
.BI \-d " displayname\fR,\fP " \-\-display " displayname" .BI \-d " displayname\fR,\fP " \-\-display= "displayname"
Create the Create the
.I Emacs .I Emacs
window on the display specified by window on the display specified by
@ -337,7 +337,7 @@ in iconified state.
.BR \-nbc ", " \-\-no\-blinking\-cursor .BR \-nbc ", " \-\-no\-blinking\-cursor
Disable blinking cursor. Disable blinking cursor.
.TP .TP
.BI \-\-parent-id " xid" .BI \-\-parent-id= "xid"
Set parent window. Set parent window.
.TP .TP
.BR \-nw ", " \-\-no\-window\-system .BR \-nw ", " \-\-no\-window\-system