diff options
| author | Glenn Morris | 2007-09-06 03:52:43 +0000 |
|---|---|---|
| committer | Glenn Morris | 2007-09-06 03:52:43 +0000 |
| commit | cbe77461dd3af5f0f2253d70cceb62ed2f6e3122 (patch) | |
| tree | 6c5a0032206a19d77200cd9da937674b835c4811 | |
| parent | a51b7a356609bb433a335fcd6f3f4a30bb72ce2a (diff) | |
| download | emacs-cbe77461dd3af5f0f2253d70cceb62ed2f6e3122.tar.gz emacs-cbe77461dd3af5f0f2253d70cceb62ed2f6e3122.zip | |
Move here from ../../etc/
| -rw-r--r-- | doc/man/ctags.1 | 3 | ||||
| -rw-r--r-- | doc/man/emacs.1 | 753 | ||||
| -rw-r--r-- | doc/man/emacsclient.1 | 88 | ||||
| -rw-r--r-- | doc/man/etags.1 | 306 |
4 files changed, 1150 insertions, 0 deletions
diff --git a/doc/man/ctags.1 b/doc/man/ctags.1 new file mode 100644 index 00000000000..9a6505b020e --- /dev/null +++ b/doc/man/ctags.1 | |||
| @@ -0,0 +1,3 @@ | |||
| 1 | .so man1/etags.1 | ||
| 2 | |||
| 3 | .\" arch-tag: 54d4579b-9d66-4ba5-9fda-f01ec83612ad | ||
diff --git a/doc/man/emacs.1 b/doc/man/emacs.1 new file mode 100644 index 00000000000..87a382272c5 --- /dev/null +++ b/doc/man/emacs.1 | |||
| @@ -0,0 +1,753 @@ | |||
| 1 | '\" t | ||
| 2 | .\" Copyright (C) 1995, 1999, 2000, 2001, 2002, 2003, 2004, | ||
| 3 | .\" 2005, 2006, 2007 Free Software Foundation, Inc. | ||
| 4 | .\" | ||
| 5 | .\" This file is part of GNU Emacs. | ||
| 6 | .\" | ||
| 7 | .\" GNU Emacs is free software; you can redistribute it and/or modify | ||
| 8 | .\" it under the terms of the GNU General Public License as published by | ||
| 9 | .\" the Free Software Foundation; either version 3, or (at your option) | ||
| 10 | .\" any later version. | ||
| 11 | .\" | ||
| 12 | .\" GNU Emacs is distributed in the hope that it will be useful, | ||
| 13 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 14 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 15 | .\" GNU General Public License for more details. | ||
| 16 | .\" | ||
| 17 | .\" You should have received a copy of the GNU General Public License | ||
| 18 | .\" along with GNU Emacs; see the file COPYING. If not, write to the | ||
| 19 | .\" Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | ||
| 20 | .\" Boston, MA 02110-1301, USA. | ||
| 21 | .\" | ||
| 22 | '\" t | ||
| 23 | .TH EMACS 1 "2007 April 13" "GNU Emacs 22.1" | ||
| 24 | . | ||
| 25 | . | ||
| 26 | .SH NAME | ||
| 27 | emacs \- GNU project Emacs | ||
| 28 | . | ||
| 29 | . | ||
| 30 | .SH SYNOPSIS | ||
| 31 | .B emacs | ||
| 32 | [ | ||
| 33 | .I command-line switches | ||
| 34 | ] [ | ||
| 35 | .I files ...\& | ||
| 36 | ] | ||
| 37 | . | ||
| 38 | . | ||
| 39 | .SH DESCRIPTION | ||
| 40 | .I GNU Emacs | ||
| 41 | is a version of | ||
| 42 | .IR Emacs , | ||
| 43 | written by the author of the original (PDP-10) | ||
| 44 | .IR Emacs , | ||
| 45 | Richard Stallman. | ||
| 46 | .br | ||
| 47 | The primary documentation of GNU Emacs is in the GNU Emacs Manual, | ||
| 48 | which you can read using Info, either from Emacs or as a standalone | ||
| 49 | program. | ||
| 50 | Please look there for complete and up-to-date documentation. | ||
| 51 | This man page is updated only when someone volunteers to do so; the | ||
| 52 | Emacs maintainers' priority goal is to minimize the amount of time | ||
| 53 | this man page takes away from other more useful projects. | ||
| 54 | .br | ||
| 55 | The user functionality of GNU Emacs encompasses | ||
| 56 | everything other | ||
| 57 | .I Emacs | ||
| 58 | editors do, and it is easily extensible since its | ||
| 59 | editing commands are written in Lisp. | ||
| 60 | .PP | ||
| 61 | .I Emacs | ||
| 62 | has an extensive interactive help facility, | ||
| 63 | but the facility assumes that you know how to manipulate | ||
| 64 | .I Emacs | ||
| 65 | windows and buffers. | ||
| 66 | CTRL-h or F1 enters the Help facility. | ||
| 67 | Help Tutorial (CTRL-h t) starts an interactive tutorial which can | ||
| 68 | teach beginners the fundamentals of | ||
| 69 | .I Emacs | ||
| 70 | in a few minutes. | ||
| 71 | Help Apropos (CTRL-h a) helps you | ||
| 72 | find a command given its functionality, Help Character (CTRL-h c) | ||
| 73 | describes a given character's effect, and Help Function (CTRL-h f) | ||
| 74 | describes a given Lisp function specified by name. | ||
| 75 | .PP | ||
| 76 | .IR Emacs 's | ||
| 77 | Undo can undo several steps of modification to your buffers, so it is | ||
| 78 | easy to recover from editing mistakes. | ||
| 79 | .PP | ||
| 80 | .IR "GNU Emacs" 's | ||
| 81 | many special packages handle mail reading (RMail) and sending (Mail), | ||
| 82 | outline editing (Outline), compiling (Compile), running subshells | ||
| 83 | within | ||
| 84 | .I Emacs | ||
| 85 | windows (Shell), running a Lisp read-eval-print loop | ||
| 86 | (Lisp-Interaction-Mode), automated psychotherapy (Doctor), and much more. | ||
| 87 | .PP | ||
| 88 | There is an extensive reference manual, but | ||
| 89 | users of other Emacses | ||
| 90 | should have little trouble adapting even | ||
| 91 | without a copy. | ||
| 92 | Users new to | ||
| 93 | .I Emacs | ||
| 94 | will be able | ||
| 95 | to use basic features fairly rapidly by studying the tutorial and | ||
| 96 | using the self-documentation features. | ||
| 97 | . | ||
| 98 | .SS Emacs Options | ||
| 99 | The following options are of general interest: | ||
| 100 | .RS | ||
| 101 | .TP 8 | ||
| 102 | .I file | ||
| 103 | Edit | ||
| 104 | .IR file . | ||
| 105 | .TP | ||
| 106 | .BI \-\-file " file\fR,\fP " \-\-find-file " file\fR,\fP " \-\-visit " file" | ||
| 107 | The same as specifying | ||
| 108 | .I file | ||
| 109 | directly as an argument. | ||
| 110 | .TP | ||
| 111 | .BI + number | ||
| 112 | Go to the line specified by | ||
| 113 | .I number | ||
| 114 | (do not insert a space between the "+" sign and | ||
| 115 | the number). | ||
| 116 | This applies only to the next file specified. | ||
| 117 | .TP | ||
| 118 | .BI + line:column | ||
| 119 | Go to the specified | ||
| 120 | .I line | ||
| 121 | and | ||
| 122 | .IR column . | ||
| 123 | .TP | ||
| 124 | .BR \-q ", " \-\-no\-init\-file | ||
| 125 | Do not load an init file. | ||
| 126 | .TP | ||
| 127 | .B \-\-no\-site\-file | ||
| 128 | Do not load the site-wide startup file. | ||
| 129 | .TP | ||
| 130 | .B \-\-no\-desktop | ||
| 131 | Do not load a saved desktop. | ||
| 132 | .TP | ||
| 133 | .BR \-nl ", " \-\-no\-shared\-memory | ||
| 134 | Do not use shared memory. | ||
| 135 | .TP | ||
| 136 | .BR \-Q ", " \-\-quick | ||
| 137 | Equivalent to "\-q \-\-no\-site\-file \-\-no\-splash". | ||
| 138 | .TP | ||
| 139 | .B \-\-no\-splash | ||
| 140 | Do not display a splash screen during start-up. | ||
| 141 | .TP | ||
| 142 | .B \-\-debug\-init | ||
| 143 | Enable | ||
| 144 | .I Emacs | ||
| 145 | Lisp debugger during the processing of the user init file | ||
| 146 | .BR ~/.emacs . | ||
| 147 | This is useful for debugging problems in the init file. | ||
| 148 | .TP | ||
| 149 | .BI \-u " user\fR,\fP " \-\-user " user" | ||
| 150 | Load | ||
| 151 | .IR user 's | ||
| 152 | init file. | ||
| 153 | .TP | ||
| 154 | .BI \-t " file\fR,\fP " \-\-terminal " file" | ||
| 155 | Use specified | ||
| 156 | .I file | ||
| 157 | as the terminal instead of using stdin/stdout. | ||
| 158 | This must be the first argument specified in the command line. | ||
| 159 | .TP | ||
| 160 | .BR \-\-multibyte ", " \-\-no-unibyte | ||
| 161 | Enable multibyte mode (enabled by default). | ||
| 162 | .TP | ||
| 163 | .BR \-\-unibyte ", " \-\-no-multibyte | ||
| 164 | Enable unibyte mode. | ||
| 165 | .TP | ||
| 166 | .B \-\-version | ||
| 167 | Display | ||
| 168 | .I Emacs | ||
| 169 | version information and exit. | ||
| 170 | .TP | ||
| 171 | .B \-\-help | ||
| 172 | Display this help and exit. | ||
| 173 | .RE | ||
| 174 | .PP | ||
| 175 | The following options are lisp-oriented | ||
| 176 | (these options are processed in the order encountered): | ||
| 177 | .RS | ||
| 178 | .TP 8 | ||
| 179 | .BI \-f " function\fR,\fP " \-\-funcall " function" | ||
| 180 | Execute the lisp function | ||
| 181 | .IR function . | ||
| 182 | .TP | ||
| 183 | .BI \-l " file\fR,\fP " \-\-load " file" | ||
| 184 | Load the lisp code in the file | ||
| 185 | .IR file . | ||
| 186 | .TP | ||
| 187 | .BI \-\-eval " expr\fR,\fP " \-\-execute " expr" | ||
| 188 | Evaluate the Lisp expression | ||
| 189 | .IR expr . | ||
| 190 | .RE | ||
| 191 | .PP | ||
| 192 | The following options are useful when running | ||
| 193 | .I Emacs | ||
| 194 | as a batch editor: | ||
| 195 | .RS | ||
| 196 | .TP 8 | ||
| 197 | .B \-\-batch | ||
| 198 | Edit in batch mode. | ||
| 199 | The editor will send messages to stderr. | ||
| 200 | This option must be the first in the argument list. | ||
| 201 | You must use \-l and \-f options to specify files to execute | ||
| 202 | and functions to call. | ||
| 203 | .TP | ||
| 204 | .BI \-\-script " file" | ||
| 205 | Run | ||
| 206 | .I file | ||
| 207 | as an Emacs Lisp script. | ||
| 208 | .TP | ||
| 209 | .BI \-\-insert " file" | ||
| 210 | Insert contents of | ||
| 211 | .I file | ||
| 212 | into the current buffer. | ||
| 213 | .TP | ||
| 214 | .B \-\-kill | ||
| 215 | Exit | ||
| 216 | .I Emacs | ||
| 217 | while in batch mode. | ||
| 218 | .TP | ||
| 219 | .BI \-L " dir\fR,\fP " \-\-directory " dir" | ||
| 220 | Add | ||
| 221 | .I dir | ||
| 222 | to the list of directories | ||
| 223 | .I Emacs | ||
| 224 | searches for Lisp files. | ||
| 225 | .RE | ||
| 226 | . | ||
| 227 | .\" START DELETING HERE IF YOU'RE NOT USING X | ||
| 228 | .SS Using Emacs with X | ||
| 229 | .I Emacs | ||
| 230 | has been tailored to work well with the X window system. | ||
| 231 | If you run | ||
| 232 | .I Emacs | ||
| 233 | from under X windows, it will create its own X window to | ||
| 234 | display in. | ||
| 235 | You will probably want to start the editor as a background | ||
| 236 | process so that you can continue using your original window. | ||
| 237 | .PP | ||
| 238 | .I Emacs | ||
| 239 | can be started with the following X switches: | ||
| 240 | .RS | ||
| 241 | .TP 8 | ||
| 242 | .BI \-\-name " name" | ||
| 243 | Specify the name which should be assigned to the initial | ||
| 244 | .I Emacs | ||
| 245 | window. | ||
| 246 | This controls looking up X resources as well as the window title. | ||
| 247 | .TP | ||
| 248 | .BI \-T " name\fR,\fP " \-\-title " name" | ||
| 249 | Specify the title for the initial X window. | ||
| 250 | .TP | ||
| 251 | .BR \-r ", " \-rv ", " \-\-reverse\-video | ||
| 252 | Display the | ||
| 253 | .I Emacs | ||
| 254 | window in reverse video. | ||
| 255 | .TP | ||
| 256 | .BI \-fn " font\fR,\fP " \-\-font " font" | ||
| 257 | Set the | ||
| 258 | .I Emacs | ||
| 259 | window's font to that specified by | ||
| 260 | .IR font . | ||
| 261 | You will find the various | ||
| 262 | .I X | ||
| 263 | fonts in the | ||
| 264 | .I /usr/lib/X11/fonts | ||
| 265 | directory. | ||
| 266 | Note that | ||
| 267 | .I Emacs | ||
| 268 | will only accept fixed width fonts. | ||
| 269 | Under the X11 Release 4 font-naming conventions, any font with the | ||
| 270 | value "m" or "c" in the eleventh field of the font name is a fixed | ||
| 271 | width font. | ||
| 272 | Furthermore, fonts whose name are of the form | ||
| 273 | .IR width x height | ||
| 274 | are generally fixed width, as is the font | ||
| 275 | .IR fixed . | ||
| 276 | See | ||
| 277 | .BR xlsfonts (1) | ||
| 278 | for more information. | ||
| 279 | |||
| 280 | When you specify a font, be sure to put a space between the | ||
| 281 | switch and the font name. | ||
| 282 | .TP | ||
| 283 | .BI \-\-xrm " resources" | ||
| 284 | Set additional X resources. | ||
| 285 | .TP | ||
| 286 | .BI "\-\-color\fR,\fP \-\-color=" mode | ||
| 287 | Override color mode for character terminals; | ||
| 288 | .I mode | ||
| 289 | defaults to `auto', and can also be `never', `auto', `always', | ||
| 290 | or a mode name like `ansi8'. | ||
| 291 | .TP | ||
| 292 | .BI \-bw " pixels\fR,\fP " \-\-border\-width " pixels" | ||
| 293 | Set the | ||
| 294 | .I Emacs | ||
| 295 | window's border width to the number of pixels specified by | ||
| 296 | .IR pixels . | ||
| 297 | Defaults to one pixel on each side of the window. | ||
| 298 | .TP | ||
| 299 | .BI \-ib " pixels\fR,\fP " \-\-internal\-border " pixels" | ||
| 300 | Set the window's internal border width to the number of pixels specified | ||
| 301 | by | ||
| 302 | .IR pixels . | ||
| 303 | Defaults to one pixel of padding on each side of the window. | ||
| 304 | .TP | ||
| 305 | .BI \-g " geometry\fR,\fP " \-\-geometry " geometry" | ||
| 306 | Set the | ||
| 307 | .I Emacs | ||
| 308 | window's width, height, and position as specified. | ||
| 309 | The geometry specification is in the standard X format; see | ||
| 310 | .BR X (7) | ||
| 311 | for more information. | ||
| 312 | The width and height are specified in characters; the default is | ||
| 313 | 80 by 24. | ||
| 314 | See the Emacs manual, section "Options for Window Size and Position", | ||
| 315 | for information on how window sizes interact | ||
| 316 | with selecting or deselecting the tool bar and menu bar. | ||
| 317 | .TP | ||
| 318 | .BI \-lsp " pixels\fR,\fP " \-\-line\-spacing " pixels" | ||
| 319 | Additional space to put between lines. | ||
| 320 | .TP | ||
| 321 | .BR \-vb ", " \-\-vertical\-scroll\-bars | ||
| 322 | Enable vertical scrollbars. | ||
| 323 | .TP | ||
| 324 | .BR \-fh ", " \-\-fullheight | ||
| 325 | Make the first frame as high as the screen. | ||
| 326 | .TP | ||
| 327 | .BR \-fs ", " \-\-fullscreen | ||
| 328 | Make the first frame fullscreen. | ||
| 329 | .TP | ||
| 330 | .BR \-fw ", " \-\-fullwidth | ||
| 331 | Make the first frame as wide as the screen. | ||
| 332 | .TP | ||
| 333 | .BI \-fg " color\fR,\fP " \-\-foreground\-color " color" | ||
| 334 | On color displays, set the color of the text. | ||
| 335 | |||
| 336 | Use the command | ||
| 337 | .I M\-x list\-colors\-display | ||
| 338 | for a list of valid color names. | ||
| 339 | .TP | ||
| 340 | .BI \-bg " color\fR,\fP " \-\-background\-color " color" | ||
| 341 | On color displays, set the color of the window's background. | ||
| 342 | .TP | ||
| 343 | .BI \-bd " color\fR,\fP " \-\-border\-color " color" | ||
| 344 | On color displays, set the color of the window's border. | ||
| 345 | .TP | ||
| 346 | .BI \-cr " color\fR,\fP " \-\-cursor\-color " color" | ||
| 347 | On color displays, set the color of the window's text cursor. | ||
| 348 | .TP | ||
| 349 | .BI \-ms " color\fR,\fP " \-\-mouse\-color " color" | ||
| 350 | On color displays, set the color of the window's mouse cursor. | ||
| 351 | .TP | ||
| 352 | .BI \-d " displayname\fR,\fP " \-\-display " displayname" | ||
| 353 | Create the | ||
| 354 | .I Emacs | ||
| 355 | window on the display specified by | ||
| 356 | .IR displayname . | ||
| 357 | Must be the first option specified in the command line. | ||
| 358 | .TP | ||
| 359 | .BR \-nbi ", " \-\-no\-bitmap\-icon | ||
| 360 | Do not use picture of gnu for Emacs icon. | ||
| 361 | .TP | ||
| 362 | .B \-\-iconic | ||
| 363 | Start | ||
| 364 | .I Emacs | ||
| 365 | in iconified state. | ||
| 366 | .TP | ||
| 367 | .BR \-nbc ", " \-\-no\-blinking\-cursor | ||
| 368 | Disable blinking cursor. | ||
| 369 | .TP | ||
| 370 | .BR \-nw ", " \-\-no\-window\-system | ||
| 371 | Tell | ||
| 372 | .I Emacs | ||
| 373 | not to use its special interface to X. | ||
| 374 | If you use this switch when invoking | ||
| 375 | .I Emacs | ||
| 376 | from an | ||
| 377 | .BR xterm (1) | ||
| 378 | window, display is done in that window. | ||
| 379 | .TP | ||
| 380 | .BR \-D ", " \-\-basic\-display | ||
| 381 | This option disables many display features; use it for | ||
| 382 | debugging Emacs. | ||
| 383 | .RE | ||
| 384 | .PP | ||
| 385 | You can set | ||
| 386 | .I X | ||
| 387 | default values for your | ||
| 388 | .I Emacs | ||
| 389 | windows in your | ||
| 390 | .I \.Xresources | ||
| 391 | file (see | ||
| 392 | .BR xrdb (1)). | ||
| 393 | Use the following format: | ||
| 394 | .IP | ||
| 395 | .RI emacs. keyword : value | ||
| 396 | .PP | ||
| 397 | where | ||
| 398 | .I value | ||
| 399 | specifies the default value of | ||
| 400 | .IR keyword . | ||
| 401 | .I Emacs | ||
| 402 | lets you set default values for the following keywords: | ||
| 403 | .RS | ||
| 404 | .TP 8 | ||
| 405 | .BR background " (class " Background ) | ||
| 406 | For color displays, | ||
| 407 | sets the window's background color. | ||
| 408 | .TP | ||
| 409 | .BR bitmapIcon " (class " BitmapIcon ) | ||
| 410 | If | ||
| 411 | .BR bitmapIcon 's | ||
| 412 | value is set to | ||
| 413 | .IR on , | ||
| 414 | the window will iconify into the "kitchen sink." | ||
| 415 | .TP | ||
| 416 | .BR borderColor " (class " BorderColor ) | ||
| 417 | For color displays, | ||
| 418 | sets the color of the window's border. | ||
| 419 | .TP | ||
| 420 | .BR borderWidth " (class " BorderWidth ) | ||
| 421 | Sets the window's border width in pixels. | ||
| 422 | .TP | ||
| 423 | .BR cursorColor " (class " Foreground ) | ||
| 424 | For color displays, | ||
| 425 | sets the color of the window's text cursor. | ||
| 426 | .TP | ||
| 427 | .BR cursorBlink " (class " CursorBlink ) | ||
| 428 | Specifies whether to make the cursor blink. | ||
| 429 | The default is | ||
| 430 | .IR on . | ||
| 431 | Use | ||
| 432 | .I off | ||
| 433 | or | ||
| 434 | .I false | ||
| 435 | to turn cursor blinking off. | ||
| 436 | .TP | ||
| 437 | .BR font " (class " Font ) | ||
| 438 | Sets the window's text font. | ||
| 439 | .TP | ||
| 440 | .BR foreground " (class " Foreground ) | ||
| 441 | For color displays, | ||
| 442 | sets the window's text color. | ||
| 443 | .TP | ||
| 444 | .BR fullscreen " (class " Fullscreen ) | ||
| 445 | The desired fullscreen size. | ||
| 446 | The value can be one of | ||
| 447 | .IR fullboth , | ||
| 448 | .IR fullwidth , | ||
| 449 | or | ||
| 450 | .IR fullheight , | ||
| 451 | which correspond to the command-line options `\-fs', `\-fw', and | ||
| 452 | `\-fh', respectively. | ||
| 453 | Note that this applies to the initial frame only. | ||
| 454 | .TP | ||
| 455 | .BR geometry " (class " Geometry ) | ||
| 456 | Sets the geometry of the | ||
| 457 | .I Emacs | ||
| 458 | window (as described above). | ||
| 459 | .TP | ||
| 460 | .BR iconName " (class " Title ) | ||
| 461 | Sets the icon name for the | ||
| 462 | .I Emacs | ||
| 463 | window icon. | ||
| 464 | .TP | ||
| 465 | .BR internalBorder " (class " BorderWidth ) | ||
| 466 | Sets the window's internal border width in pixels. | ||
| 467 | .TP | ||
| 468 | .BR lineSpacing " (class " LineSpacing ) | ||
| 469 | Additional space ("leading") between lines, in pixels. | ||
| 470 | .TP | ||
| 471 | .BR menuBar " (class " MenuBar ) | ||
| 472 | Gives frames menu bars if | ||
| 473 | .IR on ; | ||
| 474 | don't have menu bars if | ||
| 475 | .IR off . | ||
| 476 | See the Emacs manual, sections "Lucid Resources" and "LessTif | ||
| 477 | Resources", for how to control the appearance of the menu bar | ||
| 478 | if you have one. | ||
| 479 | .TP | ||
| 480 | .BR minibuffer " (class " Minibuffer ) | ||
| 481 | If | ||
| 482 | .IR none , | ||
| 483 | don't make a minibuffer in this frame. | ||
| 484 | It will use a separate minibuffer frame instead. | ||
| 485 | .TP | ||
| 486 | .BR paneFont " (class " Font ) | ||
| 487 | Font name for menu pane titles, in non-toolkit versions of | ||
| 488 | .IR Emacs . | ||
| 489 | .TP | ||
| 490 | .BR pointerColor " (class " Foreground ) | ||
| 491 | For color displays, | ||
| 492 | sets the color of the window's mouse cursor. | ||
| 493 | .TP | ||
| 494 | .BR privateColormap " (class " PrivateColormap ) | ||
| 495 | If | ||
| 496 | .IR on , | ||
| 497 | use a private color map, in the case where the "default | ||
| 498 | visual" of class | ||
| 499 | .B PseudoColor | ||
| 500 | and | ||
| 501 | .B Emacs | ||
| 502 | is using it. | ||
| 503 | .TP | ||
| 504 | .BR reverseVideo " (class " ReverseVideo ) | ||
| 505 | If | ||
| 506 | .BR reverseVideo 's | ||
| 507 | value is set to | ||
| 508 | .IR on , | ||
| 509 | the window will be displayed in reverse video. | ||
| 510 | .TP | ||
| 511 | .BR screenGamma " (class "ScreenGamma ) | ||
| 512 | Gamma correction for colors, equivalent to the frame parameter | ||
| 513 | `screen\-gamma'. | ||
| 514 | .TP | ||
| 515 | .BR scrollBarWidth " (class "ScrollBarWidth ) | ||
| 516 | The scroll bar width in pixels, equivalent to the frame parameter | ||
| 517 | `scroll\-bar\-width'. | ||
| 518 | .TP | ||
| 519 | .BR selectionFont " (class " SelectionFont ) | ||
| 520 | Font name for pop-up menu items, in non-toolkit versions of | ||
| 521 | .IR Emacs . | ||
| 522 | (For toolkit versions, see the Emacs manual, sections | ||
| 523 | "Lucid Resources" and "LessTif Resources".) | ||
| 524 | .TP | ||
| 525 | .BR selectionTimeout " (class " SelectionTimeout ) | ||
| 526 | Number of milliseconds to wait for a selection reply. | ||
| 527 | A value of 0 means wait as long as necessary. | ||
| 528 | .TP | ||
| 529 | .BR synchronous " (class " Synchronous ) | ||
| 530 | Run Emacs in synchronous mode if | ||
| 531 | .IR on . | ||
| 532 | Synchronous mode is useful for debugging X problems. | ||
| 533 | .TP | ||
| 534 | .BR title " (class " Title ) | ||
| 535 | Sets the title of the | ||
| 536 | .I Emacs | ||
| 537 | window. | ||
| 538 | .TP | ||
| 539 | .BR toolBar " (class " ToolBar ) | ||
| 540 | Number of lines to reserve for the tool bar. | ||
| 541 | .TP | ||
| 542 | .BR useXIM " (class " UseXIM ) | ||
| 543 | Turns off use of X input methods (XIM) if | ||
| 544 | .I false | ||
| 545 | or | ||
| 546 | .IR off . | ||
| 547 | .TP | ||
| 548 | .BR verticalScrollBars " (class " ScrollBars ) | ||
| 549 | Gives frames scroll bars if | ||
| 550 | .IR on ; | ||
| 551 | suppresses scroll bars if | ||
| 552 | .IR off . | ||
| 553 | .TP | ||
| 554 | .BR visualClass " (class " VisualClass ) | ||
| 555 | Specify the "visual" that X should use. | ||
| 556 | This tells X how to handle colors. | ||
| 557 | The value should start with one of | ||
| 558 | .IR TrueColor , | ||
| 559 | .IR PseudoColor , | ||
| 560 | .IR DirectColor , | ||
| 561 | .IR StaticColor , | ||
| 562 | .IR GrayScale , | ||
| 563 | and | ||
| 564 | .IR StaticGray , | ||
| 565 | followed by | ||
| 566 | .BI \- depth\fR,\fP | ||
| 567 | where | ||
| 568 | .I depth | ||
| 569 | is the number of color planes. | ||
| 570 | .RE | ||
| 571 | .PP | ||
| 572 | If you try to set color values while using a black and white display, | ||
| 573 | the window's characteristics will default as follows: | ||
| 574 | the foreground color will be set to black, | ||
| 575 | the background color will be set to white, | ||
| 576 | the border color will be set to grey, | ||
| 577 | and the text and mouse cursors will be set to black. | ||
| 578 | . | ||
| 579 | .SS Using the Mouse | ||
| 580 | .PP | ||
| 581 | The following lists some of the mouse button bindings for the | ||
| 582 | .I Emacs | ||
| 583 | window under X11. | ||
| 584 | . | ||
| 585 | .RS | ||
| 586 | .TS | ||
| 587 | l l | ||
| 588 | - - | ||
| 589 | l l. | ||
| 590 | MOUSE BUTTON FUNCTION | ||
| 591 | left Set point. | ||
| 592 | middle Paste text. | ||
| 593 | right Cut text into X cut buffer. | ||
| 594 | SHIFT-middle Cut text into X cut buffer. | ||
| 595 | SHIFT-right Paste text. | ||
| 596 | CTRL-middle Cut text into X cut buffer and kill it. | ||
| 597 | CTRL-right T{ | ||
| 598 | Select this window, then split it into two windows. | ||
| 599 | Same as typing CTRL\-x 2. | ||
| 600 | T} | ||
| 601 | .\" START DELETING HERE IF YOU'RE NOT USING X MENUS | ||
| 602 | CTRL-SHIFT-left T{ | ||
| 603 | X buffer menu \(em hold the buttons and keys | ||
| 604 | down, wait for menu to appear, select buffer, and release. | ||
| 605 | Move mouse out of menu and release to cancel. | ||
| 606 | T} | ||
| 607 | CTRL-SHIFT-middle T{ | ||
| 608 | X help menu \(em pop up index card menu for Emacs help. | ||
| 609 | T} | ||
| 610 | .\" STOP DELETING HERE IF YOU'RE NOT USING X MENUS | ||
| 611 | CTRL-SHIFT-right T{ | ||
| 612 | Select window with mouse, and delete all other windows. | ||
| 613 | Same as typing CTRL\-x 1. | ||
| 614 | T} | ||
| 615 | .\" STOP DELETING HERE IF YOU'RE NOT USING X | ||
| 616 | .TE | ||
| 617 | .RE | ||
| 618 | . | ||
| 619 | . | ||
| 620 | .SH MANUALS | ||
| 621 | You can order printed copies of the GNU Emacs Manual from the Free | ||
| 622 | Software Foundation, which develops GNU software. | ||
| 623 | See the file ORDERS for ordering information. | ||
| 624 | .br | ||
| 625 | Your local Emacs maintainer might also have copies available. | ||
| 626 | As with all software and publications from FSF, everyone is permitted | ||
| 627 | to make and distribute copies of the Emacs manual. | ||
| 628 | The TeX source to the manual is also included in the Emacs source | ||
| 629 | distribution. | ||
| 630 | . | ||
| 631 | . | ||
| 632 | .SH FILES | ||
| 633 | /usr/local/share/info \(em files for the Info documentation browser. | ||
| 634 | The complete text of the Emacs reference manual is included in a | ||
| 635 | convenient tree structured form. | ||
| 636 | Also includes the Emacs Lisp Reference Manual, useful to anyone | ||
| 637 | wishing to write programs in the Emacs Lisp extension language. | ||
| 638 | |||
| 639 | /usr/local/share/emacs/$VERSION/lisp \(em Lisp source files and | ||
| 640 | compiled files that define most editing commands. | ||
| 641 | Some are preloaded; others are autoloaded from this directory when | ||
| 642 | used. | ||
| 643 | |||
| 644 | /usr/local/libexec/emacs/$VERSION/$ARCH \(em various programs that are | ||
| 645 | used with GNU Emacs. | ||
| 646 | |||
| 647 | /usr/local/share/emacs/$VERSION/etc \(em various files of information. | ||
| 648 | |||
| 649 | /usr/local/share/emacs/$VERSION/etc/DOC.* \(em contains the documentation | ||
| 650 | strings for the Lisp primitives and preloaded Lisp functions | ||
| 651 | of GNU Emacs. | ||
| 652 | They are stored here to reduce the size of Emacs proper. | ||
| 653 | |||
| 654 | /usr/local/share/emacs/$VERSION/etc/SERVICE lists people offering | ||
| 655 | various services to assist users of GNU Emacs, including education, | ||
| 656 | troubleshooting, porting and customization. | ||
| 657 | . | ||
| 658 | . | ||
| 659 | .SH BUGS | ||
| 660 | There is a mailing list, bug-gnu-emacs@gnu.org, for reporting Emacs | ||
| 661 | bugs and fixes. | ||
| 662 | But before reporting something as a bug, please try to be sure that | ||
| 663 | it really is a bug, not a misunderstanding or a deliberate feature. | ||
| 664 | We ask you to read the section ``Reporting Emacs Bugs'' near the | ||
| 665 | end of the reference manual (or Info system) for hints on how and | ||
| 666 | when to report bugs. | ||
| 667 | Also, include the version number of the Emacs you are running in | ||
| 668 | \fIevery\fR bug report that you send in. | ||
| 669 | |||
| 670 | Do not expect a personal answer to a bug report. | ||
| 671 | The purpose of reporting bugs is to get them fixed for everyone | ||
| 672 | in the next release, if possible. | ||
| 673 | For personal assistance, look in the SERVICE file (see above) for | ||
| 674 | a list of people who offer it. | ||
| 675 | |||
| 676 | Please do not send anything but bug reports to this mailing list. | ||
| 677 | For more information about Emacs mailing lists, see the | ||
| 678 | file /usr/local/emacs/etc/MAILINGLISTS. | ||
| 679 | Bugs tend actually to be fixed if they can be isolated, so it is | ||
| 680 | in your interest to report them in such a way that they can be | ||
| 681 | easily reproduced. | ||
| 682 | . | ||
| 683 | . | ||
| 684 | .SH UNRESTRICTIONS | ||
| 685 | .I Emacs | ||
| 686 | is free; anyone may redistribute copies of | ||
| 687 | .I Emacs | ||
| 688 | to | ||
| 689 | anyone under the terms stated in the | ||
| 690 | .I Emacs | ||
| 691 | General Public License, | ||
| 692 | a copy of which accompanies each copy of | ||
| 693 | .I Emacs | ||
| 694 | and which also | ||
| 695 | appears in the reference manual. | ||
| 696 | .PP | ||
| 697 | Copies of | ||
| 698 | .I Emacs | ||
| 699 | may sometimes be received packaged with distributions of Unix systems, | ||
| 700 | but it is never included in the scope of any license covering those | ||
| 701 | systems. | ||
| 702 | Such inclusion violates the terms on which distribution is permitted. | ||
| 703 | In fact, the primary purpose of the General Public License is to | ||
| 704 | prohibit anyone from attaching any other restrictions to | ||
| 705 | redistribution of | ||
| 706 | .IR Emacs . | ||
| 707 | .PP | ||
| 708 | Richard Stallman encourages you to improve and extend | ||
| 709 | .IR Emacs , | ||
| 710 | and urges that | ||
| 711 | you contribute your extensions to the GNU library. | ||
| 712 | Eventually GNU (Gnu's Not Unix) will be a complete replacement | ||
| 713 | for Unix. | ||
| 714 | Everyone will be free to use, copy, study and change the GNU system. | ||
| 715 | . | ||
| 716 | . | ||
| 717 | .SH SEE ALSO | ||
| 718 | .BR emacsclient (1), | ||
| 719 | .BR etags (1), | ||
| 720 | .BR X (7), | ||
| 721 | .BR xlsfonts (1), | ||
| 722 | .BR xterm (1), | ||
| 723 | .BR xrdb (1) | ||
| 724 | . | ||
| 725 | . | ||
| 726 | .SH AUTHORS | ||
| 727 | .I Emacs | ||
| 728 | was written by Richard Stallman and the Free Software Foundation. | ||
| 729 | Joachim Martillo and Robert Krawitz added the X features. | ||
| 730 | . | ||
| 731 | . | ||
| 732 | .SH COPYING | ||
| 733 | Copyright | ||
| 734 | .if t \(co | ||
| 735 | .if n (C) | ||
| 736 | 1995, 1999, 2000, 2001, 2002, 2003, 2004, 2005, | ||
| 737 | 2006, 2007 Free Software Foundation, Inc. | ||
| 738 | .PP | ||
| 739 | Permission is granted to make and distribute verbatim copies of this | ||
| 740 | document provided the copyright notice and this permission notice are | ||
| 741 | preserved on all copies. | ||
| 742 | .PP | ||
| 743 | Permission is granted to copy and distribute modified versions of | ||
| 744 | this document under the conditions for verbatim copying, provided that | ||
| 745 | the entire resulting derived work is distributed under the terms of | ||
| 746 | a permission notice identical to this one. | ||
| 747 | .PP | ||
| 748 | Permission is granted to copy and distribute translations of this | ||
| 749 | document into another language, under the above conditions for | ||
| 750 | modified versions, except that this permission notice may be stated | ||
| 751 | in a translation approved by the Free Software Foundation. | ||
| 752 | . | ||
| 753 | .\" arch-tag: 04dfd376-b46e-4924-919a-cecc3b257eaa | ||
diff --git a/doc/man/emacsclient.1 b/doc/man/emacsclient.1 new file mode 100644 index 00000000000..8852372dd75 --- /dev/null +++ b/doc/man/emacsclient.1 | |||
| @@ -0,0 +1,88 @@ | |||
| 1 | .TH EMACSCLIENT 1 | ||
| 2 | .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection | ||
| 3 | .\" other parms are allowed: see man(7), man(1) | ||
| 4 | .SH NAME | ||
| 5 | emacsclient \- tells a running Emacs to visit a file | ||
| 6 | .SH SYNOPSIS | ||
| 7 | .B emacsclient | ||
| 8 | .I "[options] files ..." | ||
| 9 | .SH "DESCRIPTION" | ||
| 10 | This manual page documents briefly the | ||
| 11 | .BR emacsclient | ||
| 12 | command. Full documentation is available in the GNU Info format; see | ||
| 13 | below. | ||
| 14 | This manual page was originally written for the Debian GNU/Linux | ||
| 15 | distribution, but is not specific to that system. | ||
| 16 | .PP | ||
| 17 | .B emacsclient | ||
| 18 | works in conjunction with the built-in Emacs server. | ||
| 19 | .PP | ||
| 20 | You can either call | ||
| 21 | .B emacsclient | ||
| 22 | directly or let other programs run it for you when necessary. On | ||
| 23 | GNU and Unix systems many programs consult the environment | ||
| 24 | variable EDITOR (sometimes also VISUAL) to obtain the command used for | ||
| 25 | editing. Thus, setting this environment variable to 'emacsclient' | ||
| 26 | will allow these programs to use an already running Emacs for editing. | ||
| 27 | Other operating systems might have their own methods for defining the | ||
| 28 | default editor. | ||
| 29 | |||
| 30 | For | ||
| 31 | .B emacsclient | ||
| 32 | to work, you need an already running Emacs with a server. Within Emacs, | ||
| 33 | call the functions `server-start' or `server-mode'. (Your `.emacs' file | ||
| 34 | can do this automatically if you add either `(server-start)' or | ||
| 35 | `(server-mode 1)' to it.) | ||
| 36 | |||
| 37 | When you've finished editing the buffer, type `C-x #' | ||
| 38 | (`server-edit'). This saves the file and sends a message back to the | ||
| 39 | `emacsclient' program telling it to exit. The programs that use | ||
| 40 | `EDITOR' wait for the "editor" (actually, `emacsclient') to exit. `C-x | ||
| 41 | #' also checks for other pending external requests to edit various | ||
| 42 | files, and selects the next such file. | ||
| 43 | |||
| 44 | If you set the variable `server-window' to a window or a frame, `C-x | ||
| 45 | #' displays the server buffer in that window or in that frame. | ||
| 46 | |||
| 47 | .SH OPTIONS | ||
| 48 | The programs follow the usual GNU command line syntax, with long | ||
| 49 | options starting with two dashes (`-'). | ||
| 50 | .TP | ||
| 51 | .B \-n, \-\-no-wait | ||
| 52 | returns | ||
| 53 | immediately without waiting for you to "finish" the buffer in Emacs. | ||
| 54 | .TP | ||
| 55 | .B \-e, \-\-eval | ||
| 56 | do not visit files but instead evaluate the arguments as Emacs | ||
| 57 | Lisp expressions. | ||
| 58 | .TP | ||
| 59 | .B \-s, \-\-socket-name=FILENAME | ||
| 60 | use socket named FILENAME for communication. | ||
| 61 | .TP | ||
| 62 | .B \-f, \-\-server-file=FILENAME | ||
| 63 | use TCP configuration file FILENAME for communication. | ||
| 64 | This can also be specified via the `EMACS_SERVER_FILE' environment variable. | ||
| 65 | .TP | ||
| 66 | .B \-a, \-\-alternate-editor=EDITOR | ||
| 67 | if the Emacs server is not running, run the specified editor instead. | ||
| 68 | This can also be specified via the `ALTERNATE_EDITOR' environment variable. | ||
| 69 | .TP | ||
| 70 | .B \-d, \-\-display=DISPLAY | ||
| 71 | tell the server to display the files on the given display. | ||
| 72 | .TP | ||
| 73 | .B \-V, \-\-version | ||
| 74 | print version information and exit | ||
| 75 | .TP | ||
| 76 | .B \-h, \-\-help | ||
| 77 | print this usage information message and exit | ||
| 78 | .SH "SEE ALSO" | ||
| 79 | The program is documented fully in | ||
| 80 | .IR "Using Emacs as a Server" | ||
| 81 | available via the Info system. | ||
| 82 | .SH AUTHOR | ||
| 83 | This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>, | ||
| 84 | for the Debian GNU/Linux system (but may be used by others). | ||
| 85 | .SH COPYING | ||
| 86 | This manual page is in the public domain. | ||
| 87 | |||
| 88 | .\" arch-tag: 2b35e723-b197-4073-8752-231bc8b3d3f3 | ||
diff --git a/doc/man/etags.1 b/doc/man/etags.1 new file mode 100644 index 00000000000..04b67f389f4 --- /dev/null +++ b/doc/man/etags.1 | |||
| @@ -0,0 +1,306 @@ | |||
| 1 | .\" Copyright (C) 1992, 2001, 2002, 2003, 2004, | ||
| 2 | .\" 2005, 2006, 2007 Free Software Foundation, Inc. | ||
| 3 | .\" See section COPYING for conditions for redistribution | ||
| 4 | .TH etags 1 "23nov2001" "GNU Tools" "GNU Tools" | ||
| 5 | .de BP | ||
| 6 | .sp | ||
| 7 | .ti -.2i | ||
| 8 | \(** | ||
| 9 | .. | ||
| 10 | |||
| 11 | .SH NAME | ||
| 12 | etags, ctags \- generate tag file for Emacs, vi | ||
| 13 | .SH SYNOPSIS | ||
| 14 | .hy 0 | ||
| 15 | .na | ||
| 16 | \fBetags\fP [\|\-aCDGIRVh\|] [\|\-i \fIfile\fP\|] [\|\-l \fIlanguage\fP\|] | ||
| 17 | .if n .br | ||
| 18 | [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|] | ||
| 19 | [\|\-\-parse\-stdin=\fIfile\fP\|] | ||
| 20 | .br | ||
| 21 | [\|\-\-append\|] [\|\-\-no\-defines\|] | ||
| 22 | [\|\-\-no\-globals\|] [\|\-\-include=\fIfile\fP\|] | ||
| 23 | [\|\-\-ignore\-indentation\|] [\|\-\-language=\fIlanguage\fP\|] | ||
| 24 | [\|\-\-no\-members\|] [\|\-\-output=\fItagfile\fP\|] | ||
| 25 | [\|\-\-regex=\fIregexp\fP\|] [\|\-\-no\-regex\|] | ||
| 26 | [\|\-\-help\|] [\|\-\-version\|] | ||
| 27 | \fIfile\fP .\|.\|. | ||
| 28 | |||
| 29 | \fBctags\fP [\|\-aCdgIRVh\|] [\|\-BtTuvwx\|] [\|\-l \fIlanguage\fP\|] | ||
| 30 | .if n .br | ||
| 31 | [\|\-o \fItagfile\fP\|] [\|\-r \fIregexp\fP\|] | ||
| 32 | [\|\-\-parse\-stdin=\fIfile\fP\|] | ||
| 33 | .br | ||
| 34 | [\|\-\-append\|] [\|\-\-backward\-search\|] | ||
| 35 | [\|\-\-cxref\|] [\|\-\-defines\|] [\|\-\-forward\-search\|] | ||
| 36 | [\|\-\-globals\|] [\|\-\-ignore\-indentation\|] | ||
| 37 | [\|\-\-language=\fIlanguage\fP\|] [\|\-\-members\|] | ||
| 38 | [\|\-\-output=\fItagfile\fP\|] [\|\-\-regex=\fIregexp\fP\|] | ||
| 39 | [\|\-\-typedefs\|] [\|\-\-typedefs\-and\-c++\|] | ||
| 40 | [\|\-\-update\|] | ||
| 41 | [\|\-\-help\|] [\|\-\-version\|] | ||
| 42 | \fIfile\fP .\|.\|. | ||
| 43 | .ad b | ||
| 44 | .hy 1 | ||
| 45 | .SH DESCRIPTION | ||
| 46 | The \|\fBetags\fP\| program is used to create a tag table file, in a format | ||
| 47 | understood by | ||
| 48 | .BR emacs ( 1 )\c | ||
| 49 | \&; the \|\fBctags\fP\| program is used to create a similar table in a | ||
| 50 | format understood by | ||
| 51 | .BR vi ( 1 )\c | ||
| 52 | \&. Both forms of the program understand | ||
| 53 | the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang, HTML, | ||
| 54 | LaTeX, Emacs Lisp/Common Lisp, Lua, makefile, Pascal, Perl, PHP, Postscript, | ||
| 55 | Python, Prolog, Scheme and | ||
| 56 | most assembler\-like syntaxes. | ||
| 57 | Both forms read the files specified on the command line, and write a tag | ||
| 58 | table (defaults: \fBTAGS\fP for \fBetags\fP, \fBtags\fP for | ||
| 59 | \fBctags\fP) in the current working directory. | ||
| 60 | Files specified with relative file names will be recorded in the tag | ||
| 61 | table with file names relative to the directory where the tag table | ||
| 62 | resides. If the tag table is in /dev, however, the file names are made | ||
| 63 | relative to the working directory. Files specified with absolute file | ||
| 64 | names will be recorded | ||
| 65 | with absolute file names. Files generated from a source file\-\-like | ||
| 66 | a C file generated from a source Cweb file\-\-will be recorded with | ||
| 67 | the name of the source file. | ||
| 68 | The programs recognize the language used in an input file based on its | ||
| 69 | file name and contents. The \fB\-\-language\fP switch can be used to force | ||
| 70 | parsing of the file names following the switch according to the given | ||
| 71 | language, overriding guesses based on filename extensions. | ||
| 72 | .SH OPTIONS | ||
| 73 | Some options make sense only for the \fBvi\fP style tag files produced | ||
| 74 | by ctags; | ||
| 75 | \fBetags\fP does not recognize them. | ||
| 76 | The programs accept unambiguous abbreviations for long option names. | ||
| 77 | .TP | ||
| 78 | .B \-a, \-\-append | ||
| 79 | Append to existing tag file. (For \fBvi\fP-format tag files, see also | ||
| 80 | \fB\-\-update\fP.) | ||
| 81 | .TP | ||
| 82 | .B \-B, \-\-backward\-search | ||
| 83 | Tag files written in the format expected by \fBvi\fP contain regular | ||
| 84 | expression search instructions; the \fB\-B\fP option writes them using | ||
| 85 | the delimiter `\|\fB?\fP\|', to search \fIbackwards\fP through files. | ||
| 86 | The default is to use the delimiter `\|\fB/\fP\|', to search \fIforwards\fP | ||
| 87 | through files. | ||
| 88 | Only \fBctags\fP accepts this option. | ||
| 89 | .TP | ||
| 90 | .B \-\-declarations | ||
| 91 | In C and derived languages, create tags for function declarations, | ||
| 92 | and create tags for extern variables unless \-\-no\-globals is used. | ||
| 93 | .TP | ||
| 94 | .B \-d, \-\-defines | ||
| 95 | Create tag entries for C preprocessor constant definitions | ||
| 96 | and enum constants, too. Since this is the default behavior of | ||
| 97 | \fBetags\fP, only \fBctags\fP accepts this option. | ||
| 98 | .TP | ||
| 99 | .B \-D, \-\-no\-defines | ||
| 100 | Do not create tag entries for C preprocessor constant definitions | ||
| 101 | and enum constants. | ||
| 102 | This may make the tags file much smaller if many header files are tagged. | ||
| 103 | Since this is the default behavior of \fBctags\fP, only \fBetags\fP | ||
| 104 | accepts this option. | ||
| 105 | .TP | ||
| 106 | .B \-\-globals | ||
| 107 | Create tag entries for global variables in C, C++, Objective C, Java, | ||
| 108 | and Perl. | ||
| 109 | Since this is the default behavior of \fBetags\fP, only \fBctags\fP | ||
| 110 | accepts this option. | ||
| 111 | .TP | ||
| 112 | .B \-\-no\-globals | ||
| 113 | Do not tag global variables. Typically this reduces the file size by | ||
| 114 | one fourth. Since this is the default behavior of \fBctags\fP, only | ||
| 115 | \fBetags\fP accepts this option. | ||
| 116 | .TP | ||
| 117 | \fB\-i\fP \fIfile\fP, \fB\-\-include=\fIfile\fP | ||
| 118 | Include a note in the tag file indicating that, when searching for a | ||
| 119 | tag, one should also consult the tags file \fIfile\fP after checking the | ||
| 120 | current file. Only \fBetags\fP accepts this option. | ||
| 121 | .TP | ||
| 122 | .B \-I, \-\-ignore\-indentation | ||
| 123 | Don't rely on indentation as much as we normally do. Currently, this | ||
| 124 | means not to assume that a closing brace in the first column is the | ||
| 125 | final brace of a function or structure definition in C and C++. | ||
| 126 | .TP | ||
| 127 | \fB\-l\fP \fIlanguage\fP, \fB\-\-language=\fIlanguage\fP | ||
| 128 | Parse the following files according to the given language. More than | ||
| 129 | one such options may be intermixed with filenames. Use \fB\-\-help\fP | ||
| 130 | to get a list of the available languages and their default filename | ||
| 131 | extensions. The `auto' language can be used to restore automatic | ||
| 132 | detection of language based on the file name. The `none' | ||
| 133 | language may be used to disable language parsing altogether; only | ||
| 134 | regexp matching is done in this case (see the \fB\-\-regex\fP option). | ||
| 135 | .TP | ||
| 136 | .B \-\-members | ||
| 137 | Create tag entries for variables that are members of structure-like | ||
| 138 | constructs in C++, Objective C, Java. This is the default for etags. | ||
| 139 | .TP | ||
| 140 | .B \-\-no\-members | ||
| 141 | Do not tag member variables. This is the default for ctags. | ||
| 142 | .TP | ||
| 143 | .B \-\-packages\-only | ||
| 144 | Only tag packages in Ada files. | ||
| 145 | .TP | ||
| 146 | \fB\-\-parse\-stdin=\fIfile\fP | ||
| 147 | May be used (only once) in place of a file name on the command line. | ||
| 148 | \fBetags\fP will read from standard input and mark the produced tags | ||
| 149 | as belonging to the file \fBFILE\fP. | ||
| 150 | .TP | ||
| 151 | \fB\-o\fP \fItagfile\fP, \fB\-\-output=\fItagfile\fP | ||
| 152 | Explicit name of file for tag table; overrides default \fBTAGS\fP or | ||
| 153 | \fBtags\fP. (But ignored with \fB\-v\fP or \fB\-x\fP.) | ||
| 154 | .TP | ||
| 155 | \fB\-r\fP \fIregexp\fP, \fB\-\-regex=\fIregexp\fP | ||
| 156 | |||
| 157 | Make tags based on regexp matching for the files following this option, | ||
| 158 | in addition to the tags made with the standard parsing based on | ||
| 159 | language. May be freely intermixed with filenames and the \fB\-R\fP | ||
| 160 | option. The regexps are cumulative, i.e. each such option will add to | ||
| 161 | the previous ones. The regexps are of one of the forms: | ||
| 162 | .br | ||
| 163 | [\fB{\fP\fIlanguage\fP\fB}\fP]\fB/\fP\fItagregexp/\fP[\fInameregexp\fP\fB/\fP]\fImodifiers\fP | ||
| 164 | .br | ||
| 165 | \fB@\fP\fIregexfile\fP | ||
| 166 | .br | ||
| 167 | |||
| 168 | where \fItagregexp\fP is used to match the tag. It should not match | ||
| 169 | useless characters. If the match is such that more characters than | ||
| 170 | needed are unavoidably matched by \fItagregexp\fP, it may be useful to | ||
| 171 | add a \fInameregexp\fP, to narrow down the tag scope. \fBctags\fP | ||
| 172 | ignores regexps without a \fInameregexp\fP. The syntax of regexps is | ||
| 173 | the same as in emacs. The following character escape sequences are | ||
| 174 | supported: \\a, \\b, \\d, \\e, \\f, \\n, \\r, \\t, \\v, which | ||
| 175 | respectively stand for the ASCII characters BEL, BS, DEL, ESC, FF, NL, | ||
| 176 | CR, TAB, VT. | ||
| 177 | .br | ||
| 178 | The \fImodifiers\fP are a sequence of 0 or more characters among | ||
| 179 | \fIi\fP, which means to ignore case when matching; \fIm\fP, which means | ||
| 180 | that the \fItagregexp\fP will be matched against the whole file contents | ||
| 181 | at once, rather than line by line, and the matching sequence can match | ||
| 182 | multiple lines; and \fIs\fP, which implies \fIm\fP and means that the | ||
| 183 | dot character in \fItagregexp\fP matches the newline char as well. | ||
| 184 | .br | ||
| 185 | The separator, which is \fB/\fP in the examples, can be any character | ||
| 186 | different from space, tab, braces and \fB@\fP. If the separator | ||
| 187 | character is needed inside the regular expression, it must be quoted | ||
| 188 | by preceding it with \fB\\\fP. | ||
| 189 | .br | ||
| 190 | The optional \fB{\fP\fIlanguage\fP\fB}\fP prefix means that the tag | ||
| 191 | should be | ||
| 192 | created only for files of language \fIlanguage\fP, and ignored | ||
| 193 | otherwise. This is particularly useful when storing many predefined | ||
| 194 | regexps in a file. | ||
| 195 | .br | ||
| 196 | In its second form, \fIregexfile\fP is the name of a file that contains | ||
| 197 | a number of arguments to the \fI\-\-regex\=\fP option, | ||
| 198 | one per line. Lines beginning with a space or tab are assumed | ||
| 199 | to be comments, and ignored. | ||
| 200 | |||
| 201 | .br | ||
| 202 | Here are some examples. All the regexps are quoted to protect them | ||
| 203 | from shell interpretation. | ||
| 204 | .br | ||
| 205 | |||
| 206 | Tag the DEFVAR macros in the emacs source files: | ||
| 207 | .br | ||
| 208 | \fI\-\-regex\='/[ \\t]*DEFVAR_[A-Z_ \\t(]+"\\([^"]+\\)"/'\fP | ||
| 209 | .\"" This comment is to avoid confusion to Emacs syntax highlighting | ||
| 210 | .br | ||
| 211 | |||
| 212 | Tag VHDL files (this example is a single long line, broken here for | ||
| 213 | formatting reasons): | ||
| 214 | .br | ||
| 215 | \fI\-\-language\=none\ \-\-regex='/[\ \\t]*\\(ARCHITECTURE\\|\\ | ||
| 216 | CONFIGURATION\\)\ +[^\ ]*\ +OF/'\ \-\-regex\='/[\ \\t]*\\ | ||
| 217 | \\(ATTRIBUTE\\|ENTITY\\|FUNCTION\\|PACKAGE\\(\ BODY\\)?\\ | ||
| 218 | \\|PROCEDURE\\|PROCESS\\|TYPE\\)[\ \\t]+\\([^\ \\t(]+\\)/\\3/'\fP | ||
| 219 | .br | ||
| 220 | |||
| 221 | Tag TCL files (this last example shows the usage of a \fItagregexp\fP): | ||
| 222 | .br | ||
| 223 | \fI\-\-lang\=none \-\-regex\='/proc[\ \\t]+\\([^\ \\t]+\\)/\\1/'\fP | ||
| 224 | |||
| 225 | .br | ||
| 226 | A regexp can be preceded by {\fIlang\fP}, thus restricting it to match | ||
| 227 | lines of files of the specified language. Use \fBetags \-\-help\fP to obtain | ||
| 228 | a list of the recognised languages. This feature is particularly useful inside | ||
| 229 | \fBregex files\fP. A regex file contains one regex per line. Empty lines, | ||
| 230 | and those lines beginning with space or tab are ignored. Lines beginning | ||
| 231 | with @ are references to regex files whose name follows the @ sign. Other | ||
| 232 | lines are considered regular expressions like those following \fB\-\-regex\fP. | ||
| 233 | .br | ||
| 234 | For example, the command | ||
| 235 | .br | ||
| 236 | \fIetags \-\-regex=@regex.file *.c\fP | ||
| 237 | .br | ||
| 238 | reads the regexes contained in the file regex.file. | ||
| 239 | .TP | ||
| 240 | .B \-R, \-\-no\-regex | ||
| 241 | Don't do any more regexp matching on the following files. May be | ||
| 242 | freely intermixed with filenames and the \fB\-\-regex\fP option. | ||
| 243 | .TP | ||
| 244 | .B \-t, \-\-typedefs | ||
| 245 | Record typedefs in C code as tags. Since this is the default behavior | ||
| 246 | of \fBetags\fP, only \fBctags\fP accepts this option. | ||
| 247 | .TP | ||
| 248 | .B \-T, \-\-typedefs\-and\-c++ | ||
| 249 | Generate tag entries for typedefs, struct, enum, and union tags, and | ||
| 250 | C++ member functions. Since this is the default behavior | ||
| 251 | of \fBetags\fP, only \fBctags\fP accepts this option. | ||
| 252 | .TP | ||
| 253 | .B \-u, \-\-update | ||
| 254 | Update tag entries for \fIfiles\fP specified on command line, leaving | ||
| 255 | tag entries for other files in place. Currently, this is implemented | ||
| 256 | by deleting the existing entries for the given files and then | ||
| 257 | rewriting the new entries at the end of the tags file. It is often | ||
| 258 | faster to simply rebuild the entire tag file than to use this. | ||
| 259 | Only \fBctags\fP accepts this option. | ||
| 260 | .TP | ||
| 261 | .B \-v, \-\-vgrind | ||
| 262 | Instead of generating a tag file, write index (in \fBvgrind\fP format) | ||
| 263 | to standard output. Only \fBctags\fP accepts this option. | ||
| 264 | .TP | ||
| 265 | .B \-x, \-\-cxref | ||
| 266 | Instead of generating a tag file, write a cross reference (in | ||
| 267 | \fBcxref\fP format) to standard output. Only \fBctags\fP accepts this option. | ||
| 268 | .TP | ||
| 269 | .B \-h, \-H, \-\-help | ||
| 270 | Print usage information. Followed by one or more \-\-language=LANG | ||
| 271 | prints detailed information about how tags are created for LANG. | ||
| 272 | .TP | ||
| 273 | .B \-V, \-\-version | ||
| 274 | Print the current version of the program (same as the version of the | ||
| 275 | emacs \fBetags\fP is shipped with). | ||
| 276 | |||
| 277 | .SH "SEE ALSO" | ||
| 278 | `\|\fBemacs\fP\|' entry in \fBinfo\fP; \fIGNU Emacs Manual\fP, Richard | ||
| 279 | Stallman. | ||
| 280 | .br | ||
| 281 | .BR cxref ( 1 ), | ||
| 282 | .BR emacs ( 1 ), | ||
| 283 | .BR vgrind ( 1 ), | ||
| 284 | .BR vi ( 1 ). | ||
| 285 | |||
| 286 | .SH COPYING | ||
| 287 | Copyright | ||
| 288 | .if t \(co | ||
| 289 | .if n (c) | ||
| 290 | 1999, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. | ||
| 291 | .PP | ||
| 292 | Permission is granted to make and distribute verbatim copies of this | ||
| 293 | document provided the copyright notice and this permission notice are | ||
| 294 | preserved on all copies. | ||
| 295 | .PP | ||
| 296 | Permission is granted to copy and distribute modified versions of | ||
| 297 | this document under the conditions for verbatim copying, provided that | ||
| 298 | the entire resulting derived work is distributed under the terms of | ||
| 299 | a permission notice identical to this one. | ||
| 300 | .PP | ||
| 301 | Permission is granted to copy and distribute translations of this | ||
| 302 | document into another language, under the above conditions for | ||
| 303 | modified versions, except that this permission notice may be stated | ||
| 304 | in a translation approved by the Free Software Foundation. | ||
| 305 | |||
| 306 | .\" arch-tag: 9534977f-af78-42f0-991d-1df6b6c05573 | ||