summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/ChangeLog.12
-rw-r--r--doc/man/ebrowse.111
-rw-r--r--doc/man/emacs.1.in85
-rw-r--r--doc/man/emacsclient.147
-rw-r--r--doc/man/etags.140
5 files changed, 111 insertions, 74 deletions
diff --git a/doc/man/ChangeLog.1 b/doc/man/ChangeLog.1
index 68498c64c0d..ff675d89474 100644
--- a/doc/man/ChangeLog.1
+++ b/doc/man/ChangeLog.1
@@ -176,7 +176,7 @@
;; coding: utf-8
;; End:
- Copyright (C) 2007-2017 Free Software Foundation, Inc.
+ Copyright (C) 2007-2022 Free Software Foundation, Inc.
This file is part of GNU Emacs.
diff --git a/doc/man/ebrowse.1 b/doc/man/ebrowse.1
index ad347d13a2b..7bacdbd93e1 100644
--- a/doc/man/ebrowse.1
+++ b/doc/man/ebrowse.1
@@ -1,5 +1,5 @@
.\" See section COPYING for copyright and redistribution information.
-.TH EBROWSE 1
+.TH EBROWSE 1 "2008-12-14" "GNU Emacs" "GNU"
.SH NAME
ebrowse \- create a class hierarchy database
.SH SYNOPSIS
@@ -82,10 +82,7 @@ should give you access to the complete manual.
was written by Gerd Moellmann.
.
.SH COPYING
-Copyright
-.if t \(co
-.if n (C)
-2008-2017 Free Software Foundation, Inc.
+Copyright 2008-2022 Free Software Foundation, Inc.
.PP
Permission is granted to make and distribute verbatim copies of this
document provided the copyright notice and this permission notice are
@@ -101,3 +98,7 @@ document into another language, under the above conditions for
modified versions, except that this permission notice may be stated
in a translation approved by the Free Software Foundation.
.
+
+.\" Local Variables:
+.\" time-stamp-pattern: "3/.TH EBROWSE 1 \"%Y-%02m-%02d\" \"GNU Emacs\" \"GNU\"$"
+.\" End:
diff --git a/doc/man/emacs.1.in b/doc/man/emacs.1.in
index 0e905b7d833..7b2b5539795 100644
--- a/doc/man/emacs.1.in
+++ b/doc/man/emacs.1.in
@@ -1,5 +1,5 @@
.\" See section COPYING for copyright and redistribution information.
-.TH EMACS 1 "2007 April 13" "GNU Emacs @version@"
+.TH EMACS 1 "2022-06-07" "GNU Emacs @version@" "GNU"
.
.
.SH NAME
@@ -61,7 +61,7 @@ The following options are of general interest:
Edit
.IR file .
.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
.I file
directly as an argument.
@@ -79,7 +79,7 @@ Go to the specified
and
.IR column .
.TP
-.BI \-\-chdir " directory"
+.BI \-\-chdir= "directory"
Change to
.IR directory .
.TP
@@ -112,18 +112,22 @@ Lisp debugger during the processing of the user init file
.BR ~/.emacs .
This is useful for debugging problems in the init file.
.TP
-.BI \-u " user\fR,\fP " \-\-user " user"
+.BI \-u " user\fR,\fP " \-\-user= "user"
Load
.IR user 's
init file.
.TP
-.BI \-t " file\fR,\fP " \-\-terminal " file"
+.BI \-\-init\-directory= "directory"
+Start emacs with user-emacs-directory set to
+.IR directory .
+.TP
+.BI \-t " file\fR,\fP " \-\-terminal= "file"
Use specified
.I file
as the terminal instead of using stdin/stdout.
This must be the first argument specified in the command line.
.TP
-.BI \-\-daemon "\fR[=\fPname\fR]"
+.BI \-\-daemon "\fR[=\fPname\fR], " \-\-bg\-daemon "\fR[=\fPname\fR]"
Start Emacs as a daemon, enabling the Emacs server and disconnecting
from the terminal. You can then use the emacsclient (see
.BR emacsclient (1))
@@ -131,6 +135,9 @@ command to
connect to the server (with optional
.IR name ")."
.TP
+.BI \-\-fg\-daemon "\fR[=\fPname\fR]"
+Like "\-\-bg\-daemon", but don't disconnect from the terminal.
+.TP
.B \-\-version
Display
.I Emacs
@@ -144,15 +151,15 @@ The following options are Lisp-oriented
(these options are processed in the order encountered):
.RS
.TP 8
-.BI \-f " function\fR,\fP " \-\-funcall " function"
+.BI \-f " function\fR,\fP " \-\-funcall= "function"
Execute the lisp function
.IR function .
.TP
-.BI \-l " file\fR,\fP " \-\-load " file"
+.BI \-l " file\fR,\fP " \-\-load= "file"
Load the lisp code in the file
.IR file .
.TP
-.BI \-\-eval " expr\fR,\fP " \-\-execute " expr"
+.BI \-\-eval= "expr\fR,\fP " \-\-execute= "expr"
Evaluate the Lisp expression
.IR expr .
.RE
@@ -173,7 +180,7 @@ Run
.I file
as an Emacs Lisp script.
.TP
-.BI \-\-insert " file"
+.BI \-\-insert= "file"
Insert contents of
.I file
into the current buffer.
@@ -183,7 +190,7 @@ Exit
.I Emacs
while in batch mode.
.TP
-.BI \-L " dir\fR,\fP " \-\-directory " dir"
+.BI \-L " dir\fR,\fP " \-\-directory= "dir"
Add
.I dir
to the list of directories
@@ -194,7 +201,7 @@ searches for Lisp files.
.\" START DELETING HERE IF YOU'RE NOT USING X
.SS Using Emacs with X
.I Emacs
-has been tailored to work well with the X window system.
+has been tailored to work well with the X Window System.
If you run
.I Emacs
from under X windows, it will create its own X window to
@@ -206,13 +213,16 @@ process so that you can continue using your original window.
can be started with the following X switches:
.RS
.TP 8
-.BI \-\-name " name"
+.BI \-\-name= "name"
Specify the name which should be assigned to the initial
.I Emacs
window.
This controls looking up X resources as well as the window title.
.TP
-.BI \-T " name\fR,\fP " \-\-title " name"
+.BR \-\-no\-x\-resources
+Do not load X resources.
+.TP
+.BI \-T " name\fR,\fP " \-\-title= "name"
Specify the title for the initial X window.
.TP
.BR \-r ", " \-rv ", " \-\-reverse\-video
@@ -220,7 +230,7 @@ Display the
.I Emacs
window in reverse video.
.TP
-.BI \-fn " font\fR,\fP " \-\-font " font"
+.BI \-fn " font\fR,\fP " \-\-font= "font"
Set the
.I Emacs
window's font to that specified by
@@ -247,7 +257,7 @@ for more information.
When you specify a font, be sure to put a space between the
switch and the font name.
.TP
-.BI \-\-xrm " resources"
+.BI \-\-xrm= "resources"
Set additional X resources.
.TP
.BI "\-\-color\fR,\fP \-\-color=" mode
@@ -256,33 +266,34 @@ Override color mode for character terminals;
defaults to "auto", and can also be "never", "auto", "always",
or a mode name like "ansi8".
.TP
-.BI \-bw " pixels\fR,\fP " \-\-border\-width " pixels"
+.BI \-bw " pixels\fR,\fP " \-\-border\-width= "pixels"
Set the
.I Emacs
window's border width to the number of pixels specified by
.IR pixels .
Defaults to one pixel on each side of the window.
.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
by
.IR pixels .
Defaults to one pixel of padding on each side of the window.
.TP
-.BI \-g " geometry\fR,\fP " \-\-geometry " geometry"
+.BI \-g " geometry\fR,\fP " \-\-geometry= "geometry"
Set the
.I Emacs
window's width, height, and position as specified.
The geometry specification is in the standard X format; see
.BR X (7)
for more information.
-The width and height are specified in characters; the default is
-80 by 24.
+The width and height are specified in characters; the default for GUI
+frames is a width of 80 and a height between 35 and 40, depending on
+the OS and the window manager.
See the Emacs manual, section "Options for Window Size and Position",
for information on how window sizes interact
-with selecting or deselecting the tool bar and menu bar.
+with selecting or deselecting the tool bar, tab bar and menu bar.
.TP
-.BI \-lsp " pixels\fR,\fP " \-\-line\-spacing " pixels"
+.BI \-lsp " pixels\fR,\fP " \-\-line\-spacing= "pixels"
Additional space to put between lines.
.TP
.BR \-vb ", " \-\-vertical\-scroll\-bars
@@ -300,26 +311,26 @@ Make the first frame as wide as the screen.
.BR \-mm ", " \-\-maximized
Maximize the first frame, like "\-fw \-fh".
.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.
Use the command
.I M\-x list\-colors\-display
for a list of valid color names.
.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.
.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.
.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.
.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.
.TP
-.BI \-d " displayname\fR,\fP " \-\-display " displayname"
+.BI \-d " displayname\fR,\fP " \-\-display= "displayname"
Create the
.I Emacs
window on the display specified by
@@ -337,7 +348,7 @@ in iconified state.
.BR \-nbc ", " \-\-no\-blinking\-cursor
Disable blinking cursor.
.TP
-.BI \-\-parent-id " xid"
+.BI \-\-parent-id= "xid"
Set parent window.
.TP
.BR \-nw ", " \-\-no\-window\-system
@@ -513,6 +524,9 @@ window.
.BR toolBar " (class " ToolBar )
Number of lines to reserve for the tool bar.
.TP
+.BR tabBar " (class " TabBar )
+Number of lines to reserve for the tab bar.
+.TP
.BR useXIM " (class " UseXIM )
Turns off use of X input methods (XIM) if
.I false
@@ -559,7 +573,7 @@ distribution.
/usr/local/share/info \(em files for the Info documentation browser.
The complete text of the Emacs reference manual is included in a
convenient tree structured form.
-Also includes the Emacs Lisp Reference Manual, useful to anyone
+This includes the Emacs Lisp Reference Manual, useful to anyone
wishing to write programs in the Emacs Lisp extension language,
and the Introduction to Programming in Emacs Lisp.
@@ -650,10 +664,7 @@ For detailed credits and acknowledgments, see the GNU Emacs manual.
.
.
.SH COPYING
-Copyright
-.if t \(co
-.if n (C)
-1995, 1999-2017 Free Software Foundation, Inc.
+Copyright 1995, 1999-2022 Free Software Foundation, Inc.
.PP
Permission is granted to make and distribute verbatim copies of this
document provided the copyright notice and this permission notice are
@@ -669,3 +680,7 @@ document into another language, under the above conditions for
modified versions, except that this permission notice may be stated
in a translation approved by the Free Software Foundation.
.
+
+.\" Local Variables:
+.\" time-stamp-pattern: "3/.TH EMACS 1 \"%Y-%02m-%02d\" \"GNU Emacs @version@\" \"GNU\"$"
+.\" End:
diff --git a/doc/man/emacsclient.1 b/doc/man/emacsclient.1
index daaacab7f3e..83c8a366f8b 100644
--- a/doc/man/emacsclient.1
+++ b/doc/man/emacsclient.1
@@ -1,7 +1,7 @@
.\" See section COPYING for conditions for redistribution.
-.TH EMACSCLIENT 1
+.TH EMACSCLIENT 1 "2022-09-05" "GNU Emacs" "GNU"
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
-.\" other parms are allowed: see man(7), man(1)
+.\" other params are allowed: see man(7), man(1)
.SH NAME
emacsclient \- tells a running Emacs to visit a file
.SH SYNOPSIS
@@ -12,8 +12,6 @@ This manual page documents briefly the
.BR emacsclient
command. Full documentation is available in the GNU Info format; see
below.
-This manual page was originally written for the Debian GNU/Linux
-distribution, but is not specific to that system.
.PP
.B emacsclient
works in conjunction with the built-in Emacs server.
@@ -63,43 +61,51 @@ is treated as column 1.
This option applies only to the next file specified.
.TP
.B \-a, \-\-alternate-editor=COMMAND
-if the Emacs server is not running, run the specified shell command instead.
+If the Emacs server is not running, run the specified shell command instead.
This can also be specified via the ALTERNATE_EDITOR environment variable.
If the value of ALTERNATE_EDITOR is the empty string, run "emacs \-\-daemon" to
start Emacs in daemon mode, and try to connect to it.
.TP
.B -c, \-\-create-frame
-create a new frame instead of trying to use the current Emacs frame
+Create a new frame instead of trying to use the current Emacs frame.
+.TP
+.B -r \-\-reuse-frame
+Reuse an existing frame if one exists, otherwise create a new frame.
.TP
.B \-F, \-\-frame-parameters=ALIST
-set the parameters of a newly-created frame.
+Set the parameters of a newly-created frame.
.TP
.B \-d, \-\-display=DISPLAY
-tell the server to display the files on the given display.
+Tell the server to display the files on the given display.
.TP
.B \-e, \-\-eval
-do not visit files but instead evaluate the arguments as Emacs
+Do not visit files but instead evaluate the arguments as Emacs
Lisp expressions.
.TP
.B \-f, \-\-server-file=FILENAME
-use TCP configuration file FILENAME for communication.
+Use TCP configuration file FILENAME for communication.
This can also be specified via the EMACS_SERVER_FILE environment variable.
.TP
.B \-n, \-\-no-wait
-returns
-immediately without waiting for you to "finish" the buffer in Emacs.
+Return immediately without waiting for you to "finish" the buffer in
+Emacs. If combined with --eval, this option is ignored.
+.TP
+.B \-w, \-\-timeout=N
+How long to wait, in seconds, for Emacs to respond before giving up.
+The default is 0, which means to wait forever.
.TP
.B \-nw, \-t, \-\-tty
-open a new Emacs frame on the current terminal
+Open a new Emacs frame on the current terminal.
.TP
.B \-s, \-\-socket-name=FILENAME
-use socket named FILENAME for communication.
+Use socket named FILENAME for communication.
+This can also be specified via the EMACS_SOCKET_NAME environment variable.
.TP
.B \-V, \-\-version
-print version information and exit
+Print version information and exit.
.TP
.B \-H, \-\-help
-print this usage information message and exit
+Print this usage information message and exit.
.SH "EXIT STATUS"
Normally, the exit status is 0. If emacsclient shuts down due to
Emacs signaling an error, the exit status is 1.
@@ -108,7 +114,12 @@ The program is documented fully in
.IR "Using Emacs as a Server"
available via the Info system.
.SH AUTHOR
-This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>,
-for the Debian GNU/Linux system (but may be used by others).
+This manual page was originally written by Stephane Bortzmeyer
+<bortzmeyer@debian.org>, for the Debian GNU/Linux system, but is not
+specific to that system.
.SH COPYING
This manual page is in the public domain.
+
+.\" Local Variables:
+.\" time-stamp-pattern: "3/.TH EMACSCLIENT 1 \"%Y-%02m-%02d\" \"GNU Emacs\" \"GNU\"$"
+.\" End:
diff --git a/doc/man/etags.1 b/doc/man/etags.1
index ee3971cb760..4681a9dadbf 100644
--- a/doc/man/etags.1
+++ b/doc/man/etags.1
@@ -1,5 +1,5 @@
.\" See section COPYING for copyright and redistribution information.
-.TH etags 1 "23nov2001" "GNU Tools" "GNU Tools"
+.TH ETAGS 1 "2022-06-10" "GNU Tools" "GNU"
.de BP
.sp
.ti -.2i
@@ -50,9 +50,9 @@ format understood by
.BR vi ( 1 )\c
\&. Both forms of the program understand
the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang,
-Forth, Go, HTML, LaTeX, Emacs Lisp/Common Lisp, Lua, Makefile, Pascal, Perl,
-Ruby, PHP, PostScript, Python, Prolog, Scheme and
-most assembler\-like syntaxes.
+Forth, Go, HTML, LaTeX, Emacs Lisp/Common Lisp, Lua, Makefile, Mercury, Pascal,
+Perl, Ruby, Rust, PHP, PostScript, Python, Prolog, Scheme and most
+assembler\-like syntaxes.
Both forms read the files specified on the command line, and write a tag
table (defaults: \fBTAGS\fP for \fBetags\fP, \fBtags\fP for
\fBctags\fP) in the current working directory.
@@ -64,7 +64,7 @@ Files specified with absolute file names will be recorded
with absolute file names. Files generated from a source file\-\-like
a C file generated from a source Cweb file\-\-will be recorded with
the name of the source file.
-Compressed files are supported using gzip, bzip2, and xz.
+Compressed files are supported using gzip, bzip2, xz, and zstd.
The programs recognize the language used in an input file based on its
file name and contents. The \fB\-\-language\fP switch can be used to force
parsing of the file names following the switch according to the given
@@ -91,6 +91,9 @@ Only \fBctags\fP accepts this option.
In C and derived languages, create tags for function declarations,
and create tags for extern variables unless \-\-no\-globals is used.
In Lisp, create tags for (defvar foo) declarations.
+In Mercury, declarations start a line with "\|\fB:-\fP\|" and are always
+tagged. In addition, this option tags predicates or functions in first
+rules of clauses, as in Prolog.
.TP
.B \-D, \-\-no\-defines
Do not create tag entries for C preprocessor constant definitions
@@ -119,16 +122,22 @@ current file. Only \fBetags\fP accepts this option.
.B \-I, \-\-ignore\-indentation
Don't rely on indentation as much as we normally do. Currently, this
means not to assume that a closing brace in the first column is the
-final brace of a function or structure definition in C and C++.
+final brace of a function or structure definition in C and C++. This
+is important for code that doesn't observe the GNU Coding conventions
+of placing only top-level braces in column zero.
.TP
\fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fP
Parse the following files according to the given language. More than
one such options may be intermixed with filenames. Use \fB\-\-help\fP
to get a list of the available languages and their default filename
-extensions. The "auto" language can be used to restore automatic
-detection of language based on the file name. The "none"
-language may be used to disable language parsing altogether; only
-regexp matching is done in this case (see the \fB\-\-regex\fP option).
+extensions. For example, as Mercury and Objective-C have same
+filename extension \fI.m\fP, a test based on contents tries to detect
+the language. If this test fails, \fB\-\-language=\fP\fImercury\fP or
+\fB\-\-language=\fP\fIobjc\fP should be used.
+The "auto" language can be used to restore automatic detection of language
+based on the file name. The "none" language may be used to disable language
+parsing altogether; only regexp matching is done in this case (see the
+\fB\-\-regex\fP option).
.TP
.B \-\-members
Create tag entries for variables that are members of structure-like
@@ -145,7 +154,7 @@ May be used (only once) in place of a file name on the command line.
\fBetags\fP will read from standard input and mark the produced tags
as belonging to the file \fBFILE\fP.
.TP
-\fB \-Q, \-\-class\-qualify\fP
+\fB\-Q, \-\-class\-qualify\fP
Qualify tag names with their class name in C++, ObjC, Java, and Perl.
This produces tag names of the form \fIclass\fP\fB::\fP\fImember\fP
for C++ and Perl,
@@ -281,10 +290,7 @@ Stallman.
.BR vi ( 1 ).
.SH COPYING
-Copyright
-.if t \(co
-.if n (C)
-1992, 1999, 2001-2017 Free Software Foundation, Inc.
+Copyright 1992, 1999, 2001-2022 Free Software Foundation, Inc.
.PP
Permission is granted to make and distribute verbatim copies of this
document provided the copyright notice and this permission notice are
@@ -299,3 +305,7 @@ Permission is granted to copy and distribute translations of this
document into another language, under the above conditions for
modified versions, except that this permission notice may be stated
in a translation approved by the Free Software Foundation.
+
+.\" Local Variables:
+.\" time-stamp-pattern: "3/.TH ETAGS 1 \"%Y-%02m-%02d\" \"GNU Tools\" \"GNU\"$"
+.\" End: