Annotation of src/usr.bin/mg/mg.1, Revision 1.118
1.118 ! solene 1: .\" $OpenBSD: mg.1,v 1.117 2019/07/02 16:25:39 lum Exp $
1.34 kjell 2: .\" This file is in the public domain.
1.9 niklas 3: .\"
1.118 ! solene 4: .Dd $Mdocdate: July 2 2019 $
1.2 deraadt 5: .Dt MG 1
6: .Os
7: .Sh NAME
8: .Nm mg
9: .Nd emacs-like text editor
10: .Sh SYNOPSIS
11: .Nm mg
1.98 lum 12: .Op Fl nR
1.36 sobrado 13: .Op Fl f Ar mode
14: .Op + Ns Ar number
15: .Op Ar
1.2 deraadt 16: .Sh DESCRIPTION
17: .Nm
1.3 aaron 18: is intended to be a small, fast, and portable editor for
1.33 kjell 19: people who can't (or don't want to) run emacs for one
1.2 deraadt 20: reason or another, or are not familiar with the
21: .Xr vi 1
1.6 aaron 22: editor.
23: It is compatible with emacs because there shouldn't
1.2 deraadt 24: be any reason to learn more editor types than emacs or
25: .Xr vi 1 .
1.16 deraadt 26: .Pp
1.17 vincent 27: The options are as follows:
1.21 henning 28: .Bl -tag -width Ds
1.36 sobrado 29: .It + Ns Ar number
1.16 deraadt 30: Go to the line specified by number (do not insert
1.33 kjell 31: a space between the
32: .Sq +
33: sign and the number).
1.20 mjc 34: If a negative number is specified, the line number counts
35: backwards from the end of the file i.e. +-1 will be the last
36: line of the file, +-2 will be second last, and so on.
1.36 sobrado 37: .It Fl f Ar mode
1.17 vincent 38: Run the mode command for all buffers created from
39: arguments on the command line, including the
40: scratch buffer and all files.
1.21 henning 41: .It Fl n
42: Turn off backup file generation.
1.98 lum 43: .It Fl R
44: Files specified on the command line will be opened read-only.
1.16 deraadt 45: .El
1.33 kjell 46: .Sh WINDOWS AND BUFFERS
47: When a file is loaded into
48: .Nm ,
49: it is stored in a
50: .Em buffer .
51: This buffer may be displayed on the screen in more than one window.
52: At present, windows may only be split horizontally, so each window is
53: delineated by a modeline at the bottom.
54: If changes are made to a buffer, it will be reflected in all open windows.
1.70 florian 55: .Pp
56: If a file is changed outside
57: .Nm
58: and its buffer is about to be changed,
59: .Nm
60: prompts if the change should go ahead (y), not go ahead (n) or if the buffer
61: should be reverted (r) to the latest file on disk.
1.43 kjell 62: .Pp
63: If a buffer name begins and ends with an asterisk, the buffer is considered
1.44 jmc 64: throwaway; i.e. the user will not be prompted to save changes when
1.43 kjell 65: the buffer is killed.
1.33 kjell 66: .Sh POINT AND MARK
67: The current cursor location in
68: .Nm
69: is called the
1.39 jmc 70: .Em point
1.37 kjell 71: (or
72: .Em dot ) .
1.33 kjell 73: It is possible to define a window-specific region of text by setting a second
74: location, called the
75: .Em mark .
76: The
77: .Em region
78: is the text between point and mark inclusive.
79: Deleting the character at the mark position leaves
80: the mark at the point of deletion.
81: .Pp
82: Note: The point and mark are window-specific in
83: .Nm ,
84: not buffer-specific, as in other emacs flavours.
1.64 lum 85: .Sh BACKUP FILES
1.65 jmc 86: Backup files have a
87: .Sq ~
88: character appended to the file name and
1.64 lum 89: are created in the current working directory by default.
90: Whether to create backup files or not can be toggled with the
1.90 jmc 91: make-backup-files command.
1.64 lum 92: The backup file location can either be in the current
1.65 jmc 93: working directory, or all backups can be moved to a
94: .Pa ~/.mg.d
95: directory where files retain their path name to retain uniqueness.
1.64 lum 96: Use the backup-to-home-directory to alternate between these two locations.
1.105 tedu 97: Further, if any application creates backup files in
98: .Pa /tmp ,
1.64 lum 99: these can be left with the leave-tmpdir-backups command.
1.56 lum 100: .Sh TAGS
101: .Nm
1.57 lum 102: supports tag files created by
1.56 lum 103: .Xr ctags 1 ,
1.57 lum 104: allowing the user to quickly locate various object definitions.
105: Note though that emacs uses etags, not ctags.
1.61 lum 106: .Sh CSCOPE
107: .Nm
108: supports navigating source code using cscope.
109: However,
110: .Nm
111: requires cscope and cscope-indexer executables to be present in
112: .Ev PATH
113: for it to work.
1.33 kjell 114: .Sh DEFAULT KEY BINDINGS
1.53 lum 115: Normal editing commands are very similar to GNU Emacs.
1.47 sobrado 116: In the following examples, C-x means Control-x, and M-x means Meta-x,
1.54 lum 117: where the Meta key may be either a special key on the keyboard
1.4 deraadt 118: or the ALT key; otherwise ESC followed by the key X works as well.
119: .Pp
1.66 jmc 120: .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
1.37 kjell 121: .It C-SPC
122: set-mark-command
123: .It C-a
124: beginning-of-line
125: .It C-b
126: backward-char
1.61 lum 127: .It C-c s c
128: cscope-find-functions-calling-this-function
129: .It C-c s d
130: cscope-find-global-definition
131: .It C-c s e
132: cscope-find-egrep-pattern
133: .It C-c s f
134: cscope-find-this-file
135: .It C-c s i
136: cscope-find-files-including-file
137: .It C-c s n
138: cscope-next-symbol
139: .It C-c s p
140: cscope-prev-symbol
141: .It C-c s s
142: cscope-find-this-symbol
143: .It C-c s t
144: cscope-find-this-text-string
1.37 kjell 145: .It C-d
146: delete-char
147: .It C-e
148: end-of-line
149: .It C-f
150: forward-char
151: .It C-g
152: keyboard-quit
153: .It C-h C-h
154: help-help
155: .It C-h a
156: apropos
157: .It C-h b
158: describe-bindings
159: .It C-h c
160: describe-key-briefly
161: .It C-j
162: newline-and-indent
163: .It C-k
164: kill-line
165: .It C-l
166: recenter
167: .It RET
168: newline
169: .It C-n
170: next-line
171: .It C-o
172: open-line
173: .It C-p
174: previous-line
175: .It C-q
176: quoted-insert
177: .It C-r
178: isearch-backward
179: .It C-s
180: isearch-forward
181: .It C-t
182: transpose-chars
183: .It C-u
184: universal-argument
185: .It C-v
186: scroll-up
187: .It C-w
188: kill-region
189: .It C-x C-b
190: list-buffers
191: .It C-x C-c
192: save-buffers-kill-emacs
193: .It C-x C-f
194: find-file
195: .It C-x C-g
196: keyboard-quit
197: .It C-x C-l
198: downcase-region
199: .It C-x C-o
200: delete-blank-lines
201: .It C-x C-q
202: toggle-read-only
203: .It C-x C-r
204: find-file-read-only
205: .It C-x C-s
206: save-buffer
207: .It C-x C-u
208: upcase-region
209: .It C-x C-v
210: find-alternate-file
211: .It C-x C-w
212: write-file
213: .It C-x C-x
214: exchange-point-and-mark
215: .It C-x (
216: start-kbd-macro
1.45 nicm 217: .It C-x \&)
1.37 kjell 218: end-kbd-macro
219: .It C-x 0
220: delete-window
221: .It C-x 1
222: delete-other-windows
223: .It C-x 2
224: split-window-vertically
225: .It C-x 4 C-f
226: find-file-other-window
227: .It C-x 4 C-g
228: keyboard-quit
229: .It C-x 4 b
230: switch-to-buffer-other-window
231: .It C-x 4 f
232: find-file-other-window
233: .It C-x =
234: what-cursor-position
235: .It C-x ^
236: enlarge-window
237: .It C-x `
238: next-error
239: .It C-x b
240: switch-to-buffer
241: .It C-x d
242: dired
243: .It C-x e
244: call-last-kbd-macro
245: .It C-x f
246: set-fill-column
247: .It C-x g
248: goto-line
1.59 lum 249: .It C-x h
250: mark-whole-buffer
1.37 kjell 251: .It C-x i
252: insert-file
253: .It C-x k
254: kill-buffer
255: .It C-x n
256: other-window
257: .It C-x o
258: other-window
259: .It C-x p
260: previous-window
261: .It C-x s
262: save-some-buffers
263: .It C-x u
264: undo
265: .It C-y
266: yank
267: .It C-z
268: suspend-emacs
269: .It M-C-v
270: scroll-other-window
271: .It M-SPC
272: just-one-space
1.76 lum 273: .It M-!
274: shell-command
1.56 lum 275: .It M-.
276: find-tag
277: .It M-*
278: pop-tag-mark
1.23 deraadt 279: .It M-%
1.37 kjell 280: query-replace
1.4 deraadt 281: .It M-<
1.37 kjell 282: beginning-of-buffer
1.4 deraadt 283: .It M->
1.37 kjell 284: end-of-buffer
285: .It M-\e
286: delete-horizontal-space
1.49 kjell 287: .It M-^
288: join-line
1.37 kjell 289: .It M-b
290: backward-word
291: .It M-c
292: capitalize-word
293: .It M-d
294: kill-word
295: .It M-f
296: forward-word
1.92 lum 297: .It M-h
298: mark-paragraph
1.37 kjell 299: .It M-l
300: downcase-word
1.48 kjell 301: .It M-m
302: back-to-indentation
1.37 kjell 303: .It M-q
304: fill-paragraph
305: .It M-r
306: search-backward
307: .It M-s
308: search-forward
1.99 lum 309: .It M-t
310: transpose-words
1.37 kjell 311: .It M-u
312: upcase-word
313: .It M-v
314: scroll-down
315: .It M-w
316: copy-region-as-kill
317: .It M-x
318: execute-extended-command
319: .It M-{
320: backward-paragraph
1.59 lum 321: .It M-|
322: shell-command-on-region
1.37 kjell 323: .It M-}
324: forward-paragraph
325: .It M-~
326: not-modified
327: .It M-DEL
328: backward-kill-word
329: .It C-_
330: undo
331: .It )
332: blink-and-insert
333: .It DEL
334: delete-backward-char
1.4 deraadt 335: .El
336: .Pp
1.37 kjell 337: For a complete description of
338: .Nm
339: commands, see
340: .Sx MG COMMANDS .
341: To see the active keybindings at any time, type
1.4 deraadt 342: .Dq M-x describe-bindings .
1.37 kjell 343: .Sh MG COMMANDS
1.33 kjell 344: Commands are invoked by
345: .Dq M-x ,
346: or by binding to a key.
347: Many commands take an optional numerical parameter,
348: .Va n .
349: This parameter is set either by
350: M-<n> (where
351: .Va n
352: is the numerical argument) before the command, or by
1.60 lum 353: one or more invocations of the universal argument, usually bound to C-u.
1.33 kjell 354: When invoked in this manner, the value of the numeric parameter to
355: be passed is displayed in the minibuffer before the M-x.
1.39 jmc 356: One common use of the parameter is in mode toggles (e.g.\&
1.37 kjell 357: make-backup-files).
358: If no parameter is supplied, the mode is toggled to its
359: alternate state.
360: If a positive parameter is supplied, the mode is forced to on.
361: Otherwise, it is forced to off.
362: .\"
363: .Bl -tag -width xxxxx
364: .It apropos
365: Help Apropos.
366: Prompt the user for a string, open the *help* buffer,
367: and list all
368: .Nm
369: commands that contain that string.
1.79 lum 370: .It audible-bell
371: Toggle the audible system bell.
1.37 kjell 372: .It auto-execute
373: Register an auto-execute hook; that is, specify a filename pattern
374: (conforming to the shell's filename globbing rules) and an associated
375: function to execute when a file matching the specified pattern
376: is read into a buffer.
377: .It auto-fill-mode
1.103 lum 378: Toggle auto-fill mode (sometimes called mail-mode) in the current buffer,
1.37 kjell 379: where text inserted past the fill column is automatically wrapped
380: to a new line.
1.103 lum 381: Can be set globally with set-default-mode.
1.37 kjell 382: .It auto-indent-mode
1.103 lum 383: Toggle indent mode in the current buffer,
384: where indentation is preserved after a newline.
385: Can be set globally with set-default-mode.
1.48 kjell 386: .It back-to-indentation
387: Move the dot to the first non-whitespace character on the current line.
1.62 lum 388: .It backup-to-home-directory
1.65 jmc 389: Save backup copies to a
390: .Pa ~/.mg.d
391: directory instead of working directory.
1.62 lum 392: Requires make-backup-files to be on.
1.37 kjell 393: .It backward-char
394: Move cursor backwards one character.
395: .It backward-kill-word
396: Kill text backwards by
397: .Va n
398: words.
399: .It backward-paragraph
400: Move cursor backwards
401: .Va n
402: paragraphs.
403: Paragraphs are delimited by <NL><NL> or <NL><TAB> or <NL><SPACE>.
404: .It backward-word
405: Move cursor backwards by the specified number of words.
406: .It beginning-of-buffer
407: Move cursor to the top of the buffer.
1.115 lum 408: If set, keep mark's position, otherwise set at current position.
1.114 jmc 409: A numeric argument
410: .Va n
1.113 lum 411: will move n/10th of the way from the top.
1.37 kjell 412: .It beginning-of-line
413: Move cursor to the beginning of the line.
414: .It blink-and-insert
415: Self-insert a character, then search backwards and blink its
1.68 sobrado 416: matching delimiter.
417: For delimiters other than
1.37 kjell 418: parenthesis, brackets, and braces, the character itself
419: is used as its own match.
1.117 lum 420: Can be used in the startup file with the global-set-key command.
1.37 kjell 421: .It bsmap-mode
1.60 lum 422: Toggle bsmap mode, where DEL and C-h are swapped.
1.42 sobrado 423: .It c-mode
424: Toggle a KNF-compliant mode for editing C program files.
1.37 kjell 425: .It call-last-kbd-macro
426: Invoke the keyboard macro.
427: .It capitalize-word
428: Capitalize
429: .Va n
430: words; i.e. convert the first character of the word to
431: upper case, and subsequent letters to lower case.
432: .It cd
433: Change the global working directory.
434: See also global-wd-mode.
1.73 florian 435: .It column-number-mode
436: Toggle whether the column number is displayed in the modeline.
1.37 kjell 437: .It copy-region-as-kill
438: Copy all of the characters in the region to the kill buffer,
439: clearing the mark afterwards.
440: This is a bit like a kill-region followed by a yank.
441: .It count-matches
442: Count the number of lines matching the supplied regular expression.
443: .It count-non-matches
444: Count the number of lines not matching the supplied regular expression.
1.61 lum 445: .It cscope-find-this-symbol
446: List the matches for the given symbol.
447: .It cscope-find-global-definition
448: List global definitions for the given literal.
449: .It cscope-find-called-functions
450: List functions called from the given function.
451: .It cscope-find-functions-calling-this-function
452: List functions calling the given function.
453: .It cscope-find-this-text-string
454: List locations matching the given text string.
455: .It cscope-find-egrep-pattern
456: List locations matching the given extended regular expression pattern.
457: .It cscope-find-this-file
458: List filenames matching the given filename.
459: .It cscope-find-files-including-file
460: List files that #include the given filename.
461: .It cscope-next-symbol
462: Navigate to the next match.
463: .It cscope-prev-symbol
464: Navigate to the previous match.
465: .It cscope-next-file
1.68 sobrado 466: Navigate to the next file.
1.61 lum 467: .It cscope-prev-file
468: Navigate to the previous file.
469: .It cscope-create-list-of-files-to-index
470: Create cscope's List and Index in the given directory.
1.37 kjell 471: .It define-key
1.39 jmc 472: Prompts the user for a named keymap (mode),
1.40 sobrado 473: a key, and an
474: .Nm
475: command, then creates a keybinding in the appropriate
1.37 kjell 476: map.
477: .It delete-backward-char
478: Delete backwards
479: .Va n
480: characters.
481: Like delete-char, this actually does a kill if presented
482: with an argument.
483: .It delete-blank-lines
484: Delete blank lines around dot.
485: If dot is sitting on a blank line, this command
486: deletes all the blank lines above and below the current line.
487: Otherwise, it deletes all of the blank lines after the current line.
488: .It delete-char
489: Delete
490: .Va n
491: characters forward.
492: If any argument is present, it kills rather than deletes,
493: saving the result in the kill buffer.
494: .It delete-horizontal-space
495: Delete any whitespace around the dot.
496: .It delete-leading-space
497: Delete leading whitespace on the current line.
498: .It delete-trailing-space
499: Delete trailing whitespace on the current line.
500: .It delete-matching-lines
501: Delete all lines after dot that contain a string matching
502: the supplied regular expression.
503: .It delete-non-matching-lines
1.106 jmc 504: Delete all lines after dot that don't contain a string matching
1.37 kjell 505: the supplied regular expression.
506: .It delete-other-windows
507: Make the current window the only window visible on the screen.
508: .It delete-window
509: Delete current window.
510: .It describe-bindings
511: List all global and local keybindings, putting the result in
512: the *help* buffer.
513: .It describe-key-briefly
514: Read a key from the keyboard, and look it up in the keymap.
515: Display the name of the function currently bound to the key.
1.74 florian 516: .It diff-buffer-with-file
517: View the differences between buffer and its associated file.
1.37 kjell 518: .It digit-argument
519: Process a numerical argument for keyboard-invoked functions.
520: .It downcase-region
521: Set all characters in the region to lower case.
522: .It downcase-word
523: Set characters to lower case, starting at the dot, and ending
524: .Va n
525: words away.
526: .It emacs-version
1.40 sobrado 527: Return an
528: .Nm
529: version string.
1.37 kjell 530: .It end-kbd-macro
531: Stop defining a keyboard macro.
532: .It end-of-buffer
533: Move cursor to the end of the buffer.
1.115 lum 534: If set, keep mark's position, otherwise set at current position.
1.113 lum 535: A numeric argument
1.114 jmc 536: .Va n
1.113 lum 537: will move n/10th of the way from the end.
1.37 kjell 538: .It end-of-line
1.40 sobrado 539: Move cursor to the end of the line.
1.37 kjell 540: .It enlarge-window
541: Enlarge the current window by shrinking either the window above
542: or below it.
543: .It eval-current-buffer
1.40 sobrado 544: Evaluate the current buffer as a series of
545: .Nm
546: commands.
1.37 kjell 547: Useful for testing
548: .Nm
549: startup files.
550: .It eval-expression
551: Get one line from the user, and run it.
552: Useful for testing expressions in
553: .Nm
554: startup files.
555: .It exchange-point-and-mark
556: Swap the values of "dot" and "mark" in the current window.
557: Return an error if no mark is set.
558: .It execute-extended-command
559: Invoke an extended command; i.e. M-x.
560: Call the message line routine to read in the command name and apply
561: autocompletion to it.
562: When it comes back, look the name up in the symbol table and run the
563: command if it is found, passing arguments as necessary.
564: Print an error if there is anything wrong.
565: .It fill-paragraph
566: Justify a paragraph, wrapping text at the current fill column.
567: .It find-file
568: Select a file for editing.
1.54 lum 569: First check if the file can be found
570: in another buffer; if it is there, just switch to that buffer.
571: If the file cannot be found, create a new buffer, read in the
1.37 kjell 572: file from disk, and switch to the new buffer.
573: .It find-file-read-only
574: Same as find-file, except the new buffer is set to read-only.
575: .It find-alternate-file
576: Replace the current file with an alternate one.
577: Semantics for finding the replacement file are the same as
1.39 jmc 578: find-file, except the current buffer is killed before the switch.
1.37 kjell 579: If the kill fails, or is aborted, revert to the original file.
580: .It find-file-other-window
581: Opens the specified file in a second buffer.
582: Splits the current window if necessary.
1.56 lum 583: .It find-tag
584: Jump to definition of tag at dot.
1.37 kjell 585: .It forward-char
586: Move cursor forwards (or backwards, if
587: .Va n
588: is negative)
589: .Va n
590: characters.
591: Returns an error if the end of buffer is reached.
592: .It forward-paragraph
593: Move forward
594: .Va n
595: paragraphs.
1.39 jmc 596: Paragraphs are delimited by <NL><NL> or <NL><TAB> or <NL><SPACE>.
1.37 kjell 597: .It forward-word
598: Move the cursor forward by the specified number of words.
599: .It global-set-key
600: Bind a key in the global (fundamental) key map.
601: .It global-unset-key
1.40 sobrado 602: Unbind a key from the global (fundamental) key map; i.e. set it to 'rescan'.
1.37 kjell 603: .It global-wd-mode
604: Toggle global working-directory mode.
605: When enabled,
606: .Nm
607: defaults to opening files (and executing commands like compile and grep)
1.39 jmc 608: relative to the global working directory.
1.37 kjell 609: When disabled, a working directory is set for each buffer.
610: .It goto-line
611: Go to a specific line.
612: If an argument is present, then
613: it is the line number, else prompt for a line number to use.
614: .It help-help
1.39 jmc 615: Prompts for one of (a)propos, (b)indings, des(c)ribe key briefly.
1.37 kjell 616: .It insert
617: Insert a string, mainly for use from macros.
618: .It insert-buffer
1.40 sobrado 619: Insert the contents of another buffer at dot.
1.37 kjell 620: .It insert-file
621: Insert a file into the current buffer at dot.
622: .It insert-with-wrap
623: Insert the bound character with word wrap.
624: Check to see if we're past the fill column, and if so,
625: justify this line.
626: .It isearch-backward
627: Use incremental searching, initially in the reverse direction.
628: isearch ignores any explicit arguments.
1.39 jmc 629: If invoked during macro definition or evaluation, the non-incremental
1.37 kjell 630: search-backward is invoked instead.
631: .It isearch-forward
632: Use incremental searching, initially in the forward direction.
633: isearch ignores any explicit arguments.
1.39 jmc 634: If invoked during macro definition or evaluation, the non-incremental
1.37 kjell 635: search-forward is invoked instead.
1.49 kjell 636: .It join-line
1.50 jmc 637: Join the current line to the previous.
638: If called with an argument,
1.49 kjell 639: join the next line to the current one.
1.37 kjell 640: .It just-one-space
641: Delete any whitespace around dot, then insert a space.
642: .It keyboard-quit
643: Abort the current action.
644: .It kill-buffer
645: Dispose of a buffer, by name.
1.43 kjell 646: If the buffer name does not start and end with an asterisk,
647: prompt the user if the buffer
1.37 kjell 648: has been changed.
649: .It kill-line
650: Kill line.
651: If called without an argument, it kills from dot to the end
652: of the line, unless it is at the end of the line, when it kills the
653: newline.
654: If called with an argument of 0, it kills from the start of the
655: line to dot.
656: If called with a positive argument, it kills from dot
657: forward over that number of newlines.
658: If called with a negative argument
659: it kills any text before dot on the current line, then it kills back
660: abs(n) lines.
661: .It kill-paragraph
662: Delete
663: .Va n
664: paragraphs starting with the current one.
665: .It kill-region
1.39 jmc 666: Kill the currently defined region.
1.37 kjell 667: .It kill-word
668: Delete forward
669: .Va n
670: words.
1.67 lum 671: .It leave-tmpdir-backups
672: Modifies the behaviour of backup-to-home-directory.
1.105 tedu 673: Backup files that would normally reside in
674: .Pa /tmp
1.67 lum 675: are left there and not moved to the
676: .Pa ~/.mg.d
677: directory.
1.37 kjell 678: .It line-number-mode
1.71 florian 679: Toggle whether the line number is displayed in the modeline.
1.37 kjell 680: .It list-buffers
681: Display the list of available buffers.
682: .It load
683: Prompt the user for a filename, and then execute commands
684: from that file.
685: .It local-set-key
686: Bind a key mapping in the local (topmost) mode.
687: .It local-unset-key
688: Unbind a key mapping in the local (topmost) mode.
689: .It make-backup-files
690: Toggle generation of backup files.
1.118 ! solene 691: Enabled by default.
1.72 jasper 692: .It make-directory
693: Prompt the user for a path or directory name which is then created.
1.92 lum 694: .It mark-paragraph
1.94 lum 695: Mark
696: .Va n
697: paragraphs.
1.59 lum 698: .It mark-whole-buffer
699: Marks whole buffer as a region by putting dot at the beginning and mark
700: at the end of buffer.
1.37 kjell 701: .It meta-key-mode
702: When disabled, the meta key can be used to insert extended-ascii (8-bit)
703: characters.
704: When enabled, the meta key acts as usual.
705: .It negative-argument
1.39 jmc 706: Process a negative argument for keyboard-invoked functions.
1.37 kjell 707: .It newline
708: Insert a newline into the current buffer.
709: .It newline-and-indent
710: Insert a newline, then enough tabs and spaces to duplicate the indentation
711: of the previous line.
712: Assumes tabs are every eight characters.
713: .It next-line
714: Move forward
715: .Va n
716: lines.
1.89 jmc 717: .\" .It no-tab-mode
718: .\" Toggle notab mode.
719: .\" In this mode, spaces are inserted rather than tabs.
1.37 kjell 720: .It not-modified
721: Turn off the modified flag in the current buffer.
722: .It open-line
723: Open up some blank space.
724: Essentially, insert
725: .Va n
726: newlines, then back up over them.
727: .It other-window
728: The command to make the next (down the screen) window the current
729: window.
730: There are no real errors, although the command does nothing if
731: there is only 1 window on the screen.
732: .It overwrite-mode
1.103 lum 733: Toggle overwrite mode in the current buffer,
734: where typing overwrites existing characters rather than inserting them.
735: Can be set globally with set-default-mode.
1.37 kjell 736: .It prefix-region
737: Inserts a prefix string before each line of a region.
738: The prefix string is settable by using 'set-prefix-string'.
739: .It previous-line
740: Move backwards
741: .Va n
742: lines.
743: .It previous-window
744: This command makes the previous (up the screen) window the
745: current window.
746: There are no errors, although the command does not do
747: a lot if there is only 1 window.
1.56 lum 748: .It pop-tag-mark
749: Return to position where find-tag was previously invoked.
1.37 kjell 750: .It push-shell
1.40 sobrado 751: Suspend
752: .Nm
753: and switch to alternate screen, if available.
1.37 kjell 754: .It pwd
755: Display current (global) working directory in the status area.
756: .It query-replace
757: Query Replace.
758: Search and replace strings selectively, prompting after each match.
759: .It replace-string
760: Replace string globally without individual prompting.
761: .It query-replace-regexp
762: Replace strings selectively.
763: Does a search and replace operation using regular
764: expressions for both patterns.
765: .It quoted-insert
766: Insert the next character verbatim into the current buffer; i.e. ignore
767: any function bound to that key.
768: .It re-search-again
769: Perform a regular expression search again, using the same search
770: string and direction as the last search command.
771: .It re-search-backward
772: Search backwards using a regular expression.
773: Get a search string from the user, and search, starting at dot
774: and proceeding toward the front of the buffer.
1.39 jmc 775: If found, dot is left
1.37 kjell 776: pointing at the first character of the pattern [the last character that
777: was matched].
778: .It re-search-forward
779: Search forward using a regular expression.
780: Get a search string from the user and search for it starting at dot.
781: If found, move dot to just after the matched characters.
782: display does all
783: the hard stuff.
784: If not found, it just prints a message.
785: .It recenter
786: Reposition dot in the current window.
1.39 jmc 787: By default, the dot is centered.
1.37 kjell 788: If given a positive argument (n), the display is repositioned to line
789: n.
790: If
791: .Va n
1.40 sobrado 792: is negative, it is that line from the bottom.
1.37 kjell 793: .It redraw-display
794: Refresh the display.
795: Recomputes all window sizes in case something has changed.
1.69 jasper 796: .It revert-buffer
797: Revert the current buffer to the latest file on disk.
1.37 kjell 798: .It save-buffer
799: Save the contents of the current buffer if it has been changed,
800: optionally creating a backup copy.
801: .It save-buffers-kill-emacs
1.40 sobrado 802: Offer to save modified buffers and quit
803: .Nm .
1.37 kjell 804: .It save-some-buffers
805: Look through the list of buffers, offering to save any buffer that
806: has been changed.
807: Buffers that are not associated with files (such
808: as *scratch*, *grep*, *compile*) are ignored.
809: .It scroll-down
810: Scroll backwards
811: .Va n
812: pages.
813: A two-line overlap between pages is
814: assumed.
815: If given a repeat argument, scrolls back lines, not pages.
816: .It scroll-one-line-down
817: Scroll the display down
818: .Va n
819: lines without changing the cursor position.
820: .It scroll-one-line-up
821: Scroll the display
822: .Va n
1.40 sobrado 823: lines up without moving the cursor position.
1.37 kjell 824: .It scroll-other-window
825: Scroll the next window in the window list window forward
826: .Va n
827: pages.
828: .It scroll-up
829: Scroll forward one page.
830: A two-line overlap between pages is
831: assumed.
832: If given a repeat argument, scrolls back lines, not pages.
833: .It search-again
834: Search again, using the same search string and direction as the last
835: search command.
836: .It search-backward
837: Reverse search.
838: Get a search string from the user, and search, starting
839: at dot and proceeding toward the front of the buffer.
840: If found, dot is
841: left pointing at the first character of the pattern (the last character
842: that was matched).
843: .It search-forward
844: Search forward.
845: Get a search string from the user, and search for it
846: starting at dot.
847: If found, dot gets moved to just after the matched
848: characters, if not found, print a message.
849: .It self-insert-command
850: Insert a character.
1.104 lum 851: .It sentence-end-double-space
852: Toggle double or single spaces for end of sentences.
853: Double is the default.
854: Currently only affects fill-paragraph.
1.37 kjell 855: .It set-case-fold-search
1.58 lum 856: Set case-fold searching, causing case not to matter
1.37 kjell 857: in regular expression searches.
1.107 reyk 858: This is the default.
859: .It set-case-replace
860: Preserve the case of the replaced string.
1.37 kjell 861: This is the default.
862: .It set-default-mode
863: Append the supplied mode to the list of default modes
864: used by subsequent buffer creation.
1.102 lum 865: Built in modes include: fill, indent and overwrite.
1.37 kjell 866: .It set-fill-column
867: Prompt the user for a fill column.
868: Used by auto-fill-mode.
869: .It set-mark-command
1.40 sobrado 870: Sets the mark in the current window to the current dot location.
1.37 kjell 871: .It set-prefix-string
872: Sets the prefix string to be used by the 'prefix-region' command.
1.76 lum 873: .It shell-command
874: Execute external command from mini-buffer.
1.59 lum 875: .It shell-command-on-region
876: Provide the text in region to the shell command as input.
1.37 kjell 877: .It shrink-window
878: Shrink current window by one line.
879: The window immediately below is expanded to pick up the slack.
880: If only one window is present, this command has no effect.
881: .It split-window-vertically
882: Split the current window.
883: A window smaller than 3 lines cannot be split.
884: .It start-kbd-macro
885: Start defining a keyboard macro.
886: Macro definition is ended by invoking end-kbd-macro.
887: .It suspend-emacs
1.40 sobrado 888: Suspend
889: .Nm
890: and switch back to alternate screen, if in use.
1.37 kjell 891: .It switch-to-buffer
892: Prompt and switch to a new buffer in the current window.
893: .It switch-to-buffer-other-window
894: Switch to buffer in another window.
895: .It toggle-read-only
896: Toggle the read-only flag on the current buffer.
1.109 lum 897: .It toggle-read-only-all
898: Toggle the read-only flag on all non-ephemeral buffers.
899: A simple toggle that switches a global read-only flag either on
900: or off.
1.37 kjell 901: .It transpose-chars
1.86 lum 902: Transpose the two characters in front of and under dot,
903: then move forward one character.
1.87 jmc 904: Treat newline characters the same as any other.
1.93 lum 905: .It transpose-paragraphs
906: Transpose adjacent paragraphs.
907: If multiple iterations are requested, the current paragraph will
1.94 lum 908: be moved
909: .Va n
910: paragraphs forward.
1.99 lum 911: .It transpose-words
912: Transpose adjacent words.
1.37 kjell 913: .It undo
914: Undo the most recent action.
915: If invoked again without an intervening command,
916: move the undo pointer to the previous action and undo it.
1.41 kjell 917: .It undo-boundary
918: Add an undo boundary.
919: This is not usually done interactively.
920: .It undo-boundary-toggle
921: Toggle whether undo boundaries are generated.
922: Undo boundaries are often disabled before operations that should
923: be considered atomically undoable.
924: .It undo-enable
925: Toggle whether undo information is kept.
1.37 kjell 926: .It undo-list
927: Show the undo records for the current buffer in a new buffer.
928: .It universal-argument
929: Repeat the next command 4 times.
930: Usually bound to C-u.
1.39 jmc 931: This command may be stacked; e.g.\&
1.37 kjell 932: C-u C-u C-f moves the cursor forward 16 characters.
933: .It upcase-region
934: Upper case region.
935: Change all of the lower case characters in the region to
1.40 sobrado 936: upper case.
1.37 kjell 937: .It upcase-word
938: Move the cursor forward by the specified number of words.
1.54 lum 939: As it moves, convert any characters to upper case.
1.79 lum 940: .It visible-bell
1.81 jmc 941: Toggle the visible bell.
942: If this toggle is on, the modeline will flash.
1.56 lum 943: .It visit-tags-table
944: Record name of the tags file to be used for subsequent find-tag.
1.37 kjell 945: .It what-cursor-position
946: Display a bunch of useful information about the current location of
947: dot.
948: The character under the cursor (in octal), the current line, row,
949: and column, and approximate position of the cursor in the file (as a
950: percentage) is displayed.
951: The column position assumes an infinite
952: position display; it does not truncate just because the screen does.
953: .It write-file
954: Ask for a file name and write the contents of the current buffer to
955: that file.
956: Update the remembered file name and clear the buffer
957: changed flag.
958: .It yank
959: Yank text from kill-buffer.
1.40 sobrado 960: Unlike emacs, the
961: .Nm
962: kill buffer consists only
1.37 kjell 963: of the most recent kill.
964: It is not a ring.
1.80 lum 965: .El
966: .Sh MG DIRED KEY BINDINGS
967: Specific key bindings are available in dired mode.
968: .Pp
1.100 lum 969: .Bl -tag -width xxxxxxxxxxxxxxxxxx -offset indent -compact
1.85 lum 970: .It DEL
971: dired-unmark-backward
1.96 lum 972: .It RET, e, f and C-m
973: dired-find-file
1.108 lum 974: .It SPC, n
1.80 lum 975: dired-next-line
976: .It !
977: dired-shell-command
978: .It +
979: dired-create-directory
1.101 lum 980: .It a
981: dired-find-alternate-file
1.80 lum 982: .It c
1.82 lum 983: dired-do-copy
1.80 lum 984: .It d and C-d
1.82 lum 985: dired-flag-file-deletion
1.84 lum 986: .It g
987: dired-revert
1.116 lum 988: .It j
989: dired-goto-file
1.80 lum 990: .It o
991: dired-find-file-other-window
992: .It p
993: dired-previous-line
1.83 lum 994: .It q
995: quit-window
1.80 lum 996: .It r
1.82 lum 997: dired-do-rename
1.80 lum 998: .It u
1.82 lum 999: dired-unmark
1.80 lum 1000: .It x
1.82 lum 1001: dired-do-flagged-delete
1.80 lum 1002: .It C-v
1003: dired-scroll-down
1004: .It M-v
1005: dired-scroll-up
1.78 jmc 1006: .El
1.77 lum 1007: .Sh MG DIRED COMMANDS
1008: The following are a list of the commands specific to dired mode:
1009: .Bl -tag -width Ds
1010: .It dired-create-directory
1011: Create a directory.
1.82 lum 1012: .It dired-do-copy
1013: Copy the file listed on the current line of the dired buffer.
1014: .It dired-do-flagged-delete
1.77 lum 1015: Delete the files that have been flagged for deletion.
1.82 lum 1016: .It dired-do-rename
1017: Rename the file listed on the current line of the dired buffer.
1.101 lum 1018: .It dired-find-alternate-file
1019: Replace the current dired buffer with an alternate one as specified
1020: by the position of the cursor in the dired buffer.
1.77 lum 1021: .It dired-find-file
1022: Open the file on the current line of the dired buffer.
1.78 jmc 1023: If the cursor is on a directory it will be opened in dired mode.
1.82 lum 1024: .It dired-flag-file-deletion
1.77 lum 1025: Flag the file listed on the current line for deletion.
1026: This is indicated in the buffer by putting a D at the left margin.
1.91 lum 1027: No files are actually deleted until the function dired-do-flagged-delete
1.77 lum 1028: is executed.
1.82 lum 1029: .It dired-find-file-other-window
1030: Open the file on the current line of the dired buffer in a
1031: different window.
1.116 lum 1032: .It dired-goto-file
1033: Move the cursor to a file name in the dired buffer.
1.77 lum 1034: .It dired-next-line
1035: Move the cursor to the next line.
1036: .It dired-other-window
1037: This function works just like dired, except that it puts the
1038: dired buffer in another window.
1039: .It dired-previous-line
1040: Move the cursor to the previous line.
1.84 lum 1041: .It dired-revert
1.108 lum 1042: Refresh the dired buffer while retaining any flags.
1.77 lum 1043: .It dired-scroll-down
1044: Scroll down the dired buffer.
1045: .It dired-scroll-up
1046: Scroll up the dired buffer.
1.82 lum 1047: .It dired-unmark
1.77 lum 1048: Remove the deletion flag for the file on the current line.
1.82 lum 1049: .It dired-unmark-backward
1.85 lum 1050: Remove the deletion flag from the file listed on the previous line
1051: of the dired buffer, then move up to that line.
1.83 lum 1052: .It quit-window
1053: Close the current dired buffer.
1.37 kjell 1054: .El
1.33 kjell 1055: .Sh CONFIGURATION FILES
1.7 aaron 1056: There are two configuration files,
1.65 jmc 1057: .Pa .mg
1.1 deraadt 1058: and
1.3 aaron 1059: .Pa .mg-TERM .
1060: Here,
1061: .Ev TERM
1.65 jmc 1062: represents the name of the terminal type; e.g. if the terminal type
1.3 aaron 1063: is set to
1064: .Dq vt100 ,
1.2 deraadt 1065: .Nm
1.1 deraadt 1066: will use
1.3 aaron 1067: .Pa .mg-vt100
1.6 aaron 1068: as a startup file.
1069: The terminal type startup file is used first.
1.33 kjell 1070: .Pp
1.28 jmc 1071: The startup file format is a list of commands, one per line, as used for
1.33 kjell 1072: interactive evaluation.
1073: Strings that are normally entered by the user at any subsequent prompts
1074: may be specified after the command name; e.g.:
1.28 jmc 1075: .Bd -literal -offset indent
1.37 kjell 1076: global-set-key ")" self-insert-command
1.46 jmc 1077: global-set-key "\e^x\e^f" find-file
1078: global-set-key "\ee[Z" backward-char
1.37 kjell 1079: set-default-mode fill
1.28 jmc 1080: set-fill-column 72
1.37 kjell 1081: auto-execute *.c c-mode
1.28 jmc 1082: .Ed
1.88 lum 1083: .Pp
1084: Comments can be added to the startup files by placing
1.111 jmc 1085: .Sq ;\&
1.88 lum 1086: or
1.111 jmc 1087: .Sq #
1.88 lum 1088: as the first character of a line.
1.3 aaron 1089: .Sh FILES
1.55 lum 1090: .Bl -tag -width /usr/share/doc/mg/tutorial -compact
1.3 aaron 1091: .It Pa ~/.mg
1092: normal startup file
1093: .It Pa ~/.mg-TERM
1094: terminal-specific startup file
1.63 lum 1095: .It Pa ~/.mg.d
1096: alternative backup file location
1.52 lum 1097: .It Pa /usr/share/doc/mg/tutorial
1.51 lum 1098: concise tutorial
1.3 aaron 1099: .El
1100: .Sh SEE ALSO
1.56 lum 1101: .Xr ctags 1 ,
1.2 deraadt 1102: .Xr vi 1
1.29 reyk 1103: .Sh CAVEATS
1.37 kjell 1104: Since it is written completely in C, there is currently no
1.54 lum 1105: language in which extensions can be written;
1106: however, keys can be rebound and certain parameters can be changed
1.38 kjell 1107: in startup files.
1.33 kjell 1108: .Pp
1109: In order to use 8-bit characters (such as German umlauts), the Meta key
1110: needs to be disabled via the
1111: .Dq meta-key-mode
1112: command.
1.75 naddy 1113: .Pp
1114: Multi-byte character sets, such as UTF-8, are not supported.
![[BACK]](/icons/back.gif){kind=icon}
Return to mg.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mg