Annotation of src/usr.bin/mg/mg.1, Revision 1.109
1.109 ! lum 1: .\" $OpenBSD: mg.1,v 1.108 2018/11/18 07:57:28 lum Exp $
1.34 kjell 2: .\" This file is in the public domain.
1.9 niklas 3: .\"
1.109 ! lum 4: .Dd $Mdocdate: November 18 2018 $
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.
408: .It beginning-of-line
409: Move cursor to the beginning of the line.
410: .It blink-and-insert
411: Self-insert a character, then search backwards and blink its
1.68 sobrado 412: matching delimiter.
413: For delimiters other than
1.37 kjell 414: parenthesis, brackets, and braces, the character itself
415: is used as its own match.
416: .It bsmap-mode
1.60 lum 417: Toggle bsmap mode, where DEL and C-h are swapped.
1.42 sobrado 418: .It c-mode
419: Toggle a KNF-compliant mode for editing C program files.
1.37 kjell 420: .It call-last-kbd-macro
421: Invoke the keyboard macro.
422: .It capitalize-word
423: Capitalize
424: .Va n
425: words; i.e. convert the first character of the word to
426: upper case, and subsequent letters to lower case.
427: .It cd
428: Change the global working directory.
429: See also global-wd-mode.
1.73 florian 430: .It column-number-mode
431: Toggle whether the column number is displayed in the modeline.
1.37 kjell 432: .It copy-region-as-kill
433: Copy all of the characters in the region to the kill buffer,
434: clearing the mark afterwards.
435: This is a bit like a kill-region followed by a yank.
436: .It count-matches
437: Count the number of lines matching the supplied regular expression.
438: .It count-non-matches
439: Count the number of lines not matching the supplied regular expression.
1.61 lum 440: .It cscope-find-this-symbol
441: List the matches for the given symbol.
442: .It cscope-find-global-definition
443: List global definitions for the given literal.
444: .It cscope-find-called-functions
445: List functions called from the given function.
446: .It cscope-find-functions-calling-this-function
447: List functions calling the given function.
448: .It cscope-find-this-text-string
449: List locations matching the given text string.
450: .It cscope-find-egrep-pattern
451: List locations matching the given extended regular expression pattern.
452: .It cscope-find-this-file
453: List filenames matching the given filename.
454: .It cscope-find-files-including-file
455: List files that #include the given filename.
456: .It cscope-next-symbol
457: Navigate to the next match.
458: .It cscope-prev-symbol
459: Navigate to the previous match.
460: .It cscope-next-file
1.68 sobrado 461: Navigate to the next file.
1.61 lum 462: .It cscope-prev-file
463: Navigate to the previous file.
464: .It cscope-create-list-of-files-to-index
465: Create cscope's List and Index in the given directory.
1.37 kjell 466: .It define-key
1.39 jmc 467: Prompts the user for a named keymap (mode),
1.40 sobrado 468: a key, and an
469: .Nm
470: command, then creates a keybinding in the appropriate
1.37 kjell 471: map.
472: .It delete-backward-char
473: Delete backwards
474: .Va n
475: characters.
476: Like delete-char, this actually does a kill if presented
477: with an argument.
478: .It delete-blank-lines
479: Delete blank lines around dot.
480: If dot is sitting on a blank line, this command
481: deletes all the blank lines above and below the current line.
482: Otherwise, it deletes all of the blank lines after the current line.
483: .It delete-char
484: Delete
485: .Va n
486: characters forward.
487: If any argument is present, it kills rather than deletes,
488: saving the result in the kill buffer.
489: .It delete-horizontal-space
490: Delete any whitespace around the dot.
491: .It delete-leading-space
492: Delete leading whitespace on the current line.
493: .It delete-trailing-space
494: Delete trailing whitespace on the current line.
495: .It delete-matching-lines
496: Delete all lines after dot that contain a string matching
497: the supplied regular expression.
498: .It delete-non-matching-lines
1.106 jmc 499: Delete all lines after dot that don't contain a string matching
1.37 kjell 500: the supplied regular expression.
501: .It delete-other-windows
502: Make the current window the only window visible on the screen.
503: .It delete-window
504: Delete current window.
505: .It describe-bindings
506: List all global and local keybindings, putting the result in
507: the *help* buffer.
508: .It describe-key-briefly
509: Read a key from the keyboard, and look it up in the keymap.
510: Display the name of the function currently bound to the key.
1.74 florian 511: .It diff-buffer-with-file
512: View the differences between buffer and its associated file.
1.37 kjell 513: .It digit-argument
514: Process a numerical argument for keyboard-invoked functions.
515: .It downcase-region
516: Set all characters in the region to lower case.
517: .It downcase-word
518: Set characters to lower case, starting at the dot, and ending
519: .Va n
520: words away.
521: .It emacs-version
1.40 sobrado 522: Return an
523: .Nm
524: version string.
1.37 kjell 525: .It end-kbd-macro
526: Stop defining a keyboard macro.
527: .It end-of-buffer
528: Move cursor to the end of the buffer.
529: .It end-of-line
1.40 sobrado 530: Move cursor to the end of the line.
1.37 kjell 531: .It enlarge-window
532: Enlarge the current window by shrinking either the window above
533: or below it.
534: .It eval-current-buffer
1.40 sobrado 535: Evaluate the current buffer as a series of
536: .Nm
537: commands.
1.37 kjell 538: Useful for testing
539: .Nm
540: startup files.
541: .It eval-expression
542: Get one line from the user, and run it.
543: Useful for testing expressions in
544: .Nm
545: startup files.
546: .It exchange-point-and-mark
547: Swap the values of "dot" and "mark" in the current window.
548: Return an error if no mark is set.
549: .It execute-extended-command
550: Invoke an extended command; i.e. M-x.
551: Call the message line routine to read in the command name and apply
552: autocompletion to it.
553: When it comes back, look the name up in the symbol table and run the
554: command if it is found, passing arguments as necessary.
555: Print an error if there is anything wrong.
556: .It fill-paragraph
557: Justify a paragraph, wrapping text at the current fill column.
558: .It find-file
559: Select a file for editing.
1.54 lum 560: First check if the file can be found
561: in another buffer; if it is there, just switch to that buffer.
562: If the file cannot be found, create a new buffer, read in the
1.37 kjell 563: file from disk, and switch to the new buffer.
564: .It find-file-read-only
565: Same as find-file, except the new buffer is set to read-only.
566: .It find-alternate-file
567: Replace the current file with an alternate one.
568: Semantics for finding the replacement file are the same as
1.39 jmc 569: find-file, except the current buffer is killed before the switch.
1.37 kjell 570: If the kill fails, or is aborted, revert to the original file.
571: .It find-file-other-window
572: Opens the specified file in a second buffer.
573: Splits the current window if necessary.
1.56 lum 574: .It find-tag
575: Jump to definition of tag at dot.
1.37 kjell 576: .It forward-char
577: Move cursor forwards (or backwards, if
578: .Va n
579: is negative)
580: .Va n
581: characters.
582: Returns an error if the end of buffer is reached.
583: .It forward-paragraph
584: Move forward
585: .Va n
586: paragraphs.
1.39 jmc 587: Paragraphs are delimited by <NL><NL> or <NL><TAB> or <NL><SPACE>.
1.37 kjell 588: .It forward-word
589: Move the cursor forward by the specified number of words.
590: .It global-set-key
591: Bind a key in the global (fundamental) key map.
592: .It global-unset-key
1.40 sobrado 593: Unbind a key from the global (fundamental) key map; i.e. set it to 'rescan'.
1.37 kjell 594: .It global-wd-mode
595: Toggle global working-directory mode.
596: When enabled,
597: .Nm
598: defaults to opening files (and executing commands like compile and grep)
1.39 jmc 599: relative to the global working directory.
1.37 kjell 600: When disabled, a working directory is set for each buffer.
601: .It goto-line
602: Go to a specific line.
603: If an argument is present, then
604: it is the line number, else prompt for a line number to use.
605: .It help-help
1.39 jmc 606: Prompts for one of (a)propos, (b)indings, des(c)ribe key briefly.
1.37 kjell 607: .It insert
608: Insert a string, mainly for use from macros.
609: .It insert-buffer
1.40 sobrado 610: Insert the contents of another buffer at dot.
1.37 kjell 611: .It insert-file
612: Insert a file into the current buffer at dot.
613: .It insert-with-wrap
614: Insert the bound character with word wrap.
615: Check to see if we're past the fill column, and if so,
616: justify this line.
617: .It isearch-backward
618: Use incremental searching, initially in the reverse direction.
619: isearch ignores any explicit arguments.
1.39 jmc 620: If invoked during macro definition or evaluation, the non-incremental
1.37 kjell 621: search-backward is invoked instead.
622: .It isearch-forward
623: Use incremental searching, initially in the forward direction.
624: isearch ignores any explicit arguments.
1.39 jmc 625: If invoked during macro definition or evaluation, the non-incremental
1.37 kjell 626: search-forward is invoked instead.
1.49 kjell 627: .It join-line
1.50 jmc 628: Join the current line to the previous.
629: If called with an argument,
1.49 kjell 630: join the next line to the current one.
1.37 kjell 631: .It just-one-space
632: Delete any whitespace around dot, then insert a space.
633: .It keyboard-quit
634: Abort the current action.
635: .It kill-buffer
636: Dispose of a buffer, by name.
1.43 kjell 637: If the buffer name does not start and end with an asterisk,
638: prompt the user if the buffer
1.37 kjell 639: has been changed.
640: .It kill-line
641: Kill line.
642: If called without an argument, it kills from dot to the end
643: of the line, unless it is at the end of the line, when it kills the
644: newline.
645: If called with an argument of 0, it kills from the start of the
646: line to dot.
647: If called with a positive argument, it kills from dot
648: forward over that number of newlines.
649: If called with a negative argument
650: it kills any text before dot on the current line, then it kills back
651: abs(n) lines.
652: .It kill-paragraph
653: Delete
654: .Va n
655: paragraphs starting with the current one.
656: .It kill-region
1.39 jmc 657: Kill the currently defined region.
1.37 kjell 658: .It kill-word
659: Delete forward
660: .Va n
661: words.
1.67 lum 662: .It leave-tmpdir-backups
663: Modifies the behaviour of backup-to-home-directory.
1.105 tedu 664: Backup files that would normally reside in
665: .Pa /tmp
1.67 lum 666: are left there and not moved to the
667: .Pa ~/.mg.d
668: directory.
1.37 kjell 669: .It line-number-mode
1.71 florian 670: Toggle whether the line number is displayed in the modeline.
1.37 kjell 671: .It list-buffers
672: Display the list of available buffers.
673: .It load
674: Prompt the user for a filename, and then execute commands
675: from that file.
676: .It local-set-key
677: Bind a key mapping in the local (topmost) mode.
678: .It local-unset-key
679: Unbind a key mapping in the local (topmost) mode.
680: .It make-backup-files
681: Toggle generation of backup files.
1.72 jasper 682: .It make-directory
683: Prompt the user for a path or directory name which is then created.
1.92 lum 684: .It mark-paragraph
1.94 lum 685: Mark
686: .Va n
687: paragraphs.
1.59 lum 688: .It mark-whole-buffer
689: Marks whole buffer as a region by putting dot at the beginning and mark
690: at the end of buffer.
1.37 kjell 691: .It meta-key-mode
692: When disabled, the meta key can be used to insert extended-ascii (8-bit)
693: characters.
694: When enabled, the meta key acts as usual.
695: .It negative-argument
1.39 jmc 696: Process a negative argument for keyboard-invoked functions.
1.37 kjell 697: .It newline
698: Insert a newline into the current buffer.
699: .It newline-and-indent
700: Insert a newline, then enough tabs and spaces to duplicate the indentation
701: of the previous line.
702: Assumes tabs are every eight characters.
703: .It next-line
704: Move forward
705: .Va n
706: lines.
1.89 jmc 707: .\" .It no-tab-mode
708: .\" Toggle notab mode.
709: .\" In this mode, spaces are inserted rather than tabs.
1.37 kjell 710: .It not-modified
711: Turn off the modified flag in the current buffer.
712: .It open-line
713: Open up some blank space.
714: Essentially, insert
715: .Va n
716: newlines, then back up over them.
717: .It other-window
718: The command to make the next (down the screen) window the current
719: window.
720: There are no real errors, although the command does nothing if
721: there is only 1 window on the screen.
722: .It overwrite-mode
1.103 lum 723: Toggle overwrite mode in the current buffer,
724: where typing overwrites existing characters rather than inserting them.
725: Can be set globally with set-default-mode.
1.37 kjell 726: .It prefix-region
727: Inserts a prefix string before each line of a region.
728: The prefix string is settable by using 'set-prefix-string'.
729: .It previous-line
730: Move backwards
731: .Va n
732: lines.
733: .It previous-window
734: This command makes the previous (up the screen) window the
735: current window.
736: There are no errors, although the command does not do
737: a lot if there is only 1 window.
1.56 lum 738: .It pop-tag-mark
739: Return to position where find-tag was previously invoked.
1.37 kjell 740: .It push-shell
1.40 sobrado 741: Suspend
742: .Nm
743: and switch to alternate screen, if available.
1.37 kjell 744: .It pwd
745: Display current (global) working directory in the status area.
746: .It query-replace
747: Query Replace.
748: Search and replace strings selectively, prompting after each match.
749: .It replace-string
750: Replace string globally without individual prompting.
751: .It query-replace-regexp
752: Replace strings selectively.
753: Does a search and replace operation using regular
754: expressions for both patterns.
755: .It quoted-insert
756: Insert the next character verbatim into the current buffer; i.e. ignore
757: any function bound to that key.
758: .It re-search-again
759: Perform a regular expression search again, using the same search
760: string and direction as the last search command.
761: .It re-search-backward
762: Search backwards using a regular expression.
763: Get a search string from the user, and search, starting at dot
764: and proceeding toward the front of the buffer.
1.39 jmc 765: If found, dot is left
1.37 kjell 766: pointing at the first character of the pattern [the last character that
767: was matched].
768: .It re-search-forward
769: Search forward using a regular expression.
770: Get a search string from the user and search for it starting at dot.
771: If found, move dot to just after the matched characters.
772: display does all
773: the hard stuff.
774: If not found, it just prints a message.
775: .It recenter
776: Reposition dot in the current window.
1.39 jmc 777: By default, the dot is centered.
1.37 kjell 778: If given a positive argument (n), the display is repositioned to line
779: n.
780: If
781: .Va n
1.40 sobrado 782: is negative, it is that line from the bottom.
1.37 kjell 783: .It redraw-display
784: Refresh the display.
785: Recomputes all window sizes in case something has changed.
1.69 jasper 786: .It revert-buffer
787: Revert the current buffer to the latest file on disk.
1.37 kjell 788: .It save-buffer
789: Save the contents of the current buffer if it has been changed,
790: optionally creating a backup copy.
791: .It save-buffers-kill-emacs
1.40 sobrado 792: Offer to save modified buffers and quit
793: .Nm .
1.37 kjell 794: .It save-some-buffers
795: Look through the list of buffers, offering to save any buffer that
796: has been changed.
797: Buffers that are not associated with files (such
798: as *scratch*, *grep*, *compile*) are ignored.
799: .It scroll-down
800: Scroll backwards
801: .Va n
802: pages.
803: A two-line overlap between pages is
804: assumed.
805: If given a repeat argument, scrolls back lines, not pages.
806: .It scroll-one-line-down
807: Scroll the display down
808: .Va n
809: lines without changing the cursor position.
810: .It scroll-one-line-up
811: Scroll the display
812: .Va n
1.40 sobrado 813: lines up without moving the cursor position.
1.37 kjell 814: .It scroll-other-window
815: Scroll the next window in the window list window forward
816: .Va n
817: pages.
818: .It scroll-up
819: Scroll forward one page.
820: A two-line overlap between pages is
821: assumed.
822: If given a repeat argument, scrolls back lines, not pages.
823: .It search-again
824: Search again, using the same search string and direction as the last
825: search command.
826: .It search-backward
827: Reverse search.
828: Get a search string from the user, and search, starting
829: at dot and proceeding toward the front of the buffer.
830: If found, dot is
831: left pointing at the first character of the pattern (the last character
832: that was matched).
833: .It search-forward
834: Search forward.
835: Get a search string from the user, and search for it
836: starting at dot.
837: If found, dot gets moved to just after the matched
838: characters, if not found, print a message.
839: .It self-insert-command
840: Insert a character.
1.104 lum 841: .It sentence-end-double-space
842: Toggle double or single spaces for end of sentences.
843: Double is the default.
844: Currently only affects fill-paragraph.
1.37 kjell 845: .It set-case-fold-search
1.58 lum 846: Set case-fold searching, causing case not to matter
1.37 kjell 847: in regular expression searches.
1.107 reyk 848: This is the default.
849: .It set-case-replace
850: Preserve the case of the replaced string.
1.37 kjell 851: This is the default.
852: .It set-default-mode
853: Append the supplied mode to the list of default modes
854: used by subsequent buffer creation.
1.102 lum 855: Built in modes include: fill, indent and overwrite.
1.37 kjell 856: .It set-fill-column
857: Prompt the user for a fill column.
858: Used by auto-fill-mode.
859: .It set-mark-command
1.40 sobrado 860: Sets the mark in the current window to the current dot location.
1.37 kjell 861: .It set-prefix-string
862: Sets the prefix string to be used by the 'prefix-region' command.
1.76 lum 863: .It shell-command
864: Execute external command from mini-buffer.
1.59 lum 865: .It shell-command-on-region
866: Provide the text in region to the shell command as input.
1.37 kjell 867: .It shrink-window
868: Shrink current window by one line.
869: The window immediately below is expanded to pick up the slack.
870: If only one window is present, this command has no effect.
871: .It split-window-vertically
872: Split the current window.
873: A window smaller than 3 lines cannot be split.
874: .It start-kbd-macro
875: Start defining a keyboard macro.
876: Macro definition is ended by invoking end-kbd-macro.
877: .It suspend-emacs
1.40 sobrado 878: Suspend
879: .Nm
880: and switch back to alternate screen, if in use.
1.37 kjell 881: .It switch-to-buffer
882: Prompt and switch to a new buffer in the current window.
883: .It switch-to-buffer-other-window
884: Switch to buffer in another window.
885: .It toggle-read-only
886: Toggle the read-only flag on the current buffer.
1.109 ! lum 887: .It toggle-read-only-all
! 888: Toggle the read-only flag on all non-ephemeral buffers.
! 889: A simple toggle that switches a global read-only flag either on
! 890: or off.
1.37 kjell 891: .It transpose-chars
1.86 lum 892: Transpose the two characters in front of and under dot,
893: then move forward one character.
1.87 jmc 894: Treat newline characters the same as any other.
1.93 lum 895: .It transpose-paragraphs
896: Transpose adjacent paragraphs.
897: If multiple iterations are requested, the current paragraph will
1.94 lum 898: be moved
899: .Va n
900: paragraphs forward.
1.99 lum 901: .It transpose-words
902: Transpose adjacent words.
1.37 kjell 903: .It undo
904: Undo the most recent action.
905: If invoked again without an intervening command,
906: move the undo pointer to the previous action and undo it.
1.41 kjell 907: .It undo-boundary
908: Add an undo boundary.
909: This is not usually done interactively.
910: .It undo-boundary-toggle
911: Toggle whether undo boundaries are generated.
912: Undo boundaries are often disabled before operations that should
913: be considered atomically undoable.
914: .It undo-enable
915: Toggle whether undo information is kept.
1.37 kjell 916: .It undo-list
917: Show the undo records for the current buffer in a new buffer.
918: .It universal-argument
919: Repeat the next command 4 times.
920: Usually bound to C-u.
1.39 jmc 921: This command may be stacked; e.g.\&
1.37 kjell 922: C-u C-u C-f moves the cursor forward 16 characters.
923: .It upcase-region
924: Upper case region.
925: Change all of the lower case characters in the region to
1.40 sobrado 926: upper case.
1.37 kjell 927: .It upcase-word
928: Move the cursor forward by the specified number of words.
1.54 lum 929: As it moves, convert any characters to upper case.
1.79 lum 930: .It visible-bell
1.81 jmc 931: Toggle the visible bell.
932: If this toggle is on, the modeline will flash.
1.56 lum 933: .It visit-tags-table
934: Record name of the tags file to be used for subsequent find-tag.
1.37 kjell 935: .It what-cursor-position
936: Display a bunch of useful information about the current location of
937: dot.
938: The character under the cursor (in octal), the current line, row,
939: and column, and approximate position of the cursor in the file (as a
940: percentage) is displayed.
941: The column position assumes an infinite
942: position display; it does not truncate just because the screen does.
943: .It write-file
944: Ask for a file name and write the contents of the current buffer to
945: that file.
946: Update the remembered file name and clear the buffer
947: changed flag.
948: .It yank
949: Yank text from kill-buffer.
1.40 sobrado 950: Unlike emacs, the
951: .Nm
952: kill buffer consists only
1.37 kjell 953: of the most recent kill.
954: It is not a ring.
1.80 lum 955: .El
956: .Sh MG DIRED KEY BINDINGS
957: Specific key bindings are available in dired mode.
958: .Pp
1.100 lum 959: .Bl -tag -width xxxxxxxxxxxxxxxxxx -offset indent -compact
1.85 lum 960: .It DEL
961: dired-unmark-backward
1.96 lum 962: .It RET, e, f and C-m
963: dired-find-file
1.108 lum 964: .It SPC, n
1.80 lum 965: dired-next-line
966: .It !
967: dired-shell-command
968: .It +
969: dired-create-directory
1.101 lum 970: .It a
971: dired-find-alternate-file
1.80 lum 972: .It c
1.82 lum 973: dired-do-copy
1.80 lum 974: .It d and C-d
1.82 lum 975: dired-flag-file-deletion
1.84 lum 976: .It g
977: dired-revert
1.80 lum 978: .It o
979: dired-find-file-other-window
980: .It p
981: dired-previous-line
1.83 lum 982: .It q
983: quit-window
1.80 lum 984: .It r
1.82 lum 985: dired-do-rename
1.80 lum 986: .It u
1.82 lum 987: dired-unmark
1.80 lum 988: .It x
1.82 lum 989: dired-do-flagged-delete
1.80 lum 990: .It C-v
991: dired-scroll-down
992: .It M-v
993: dired-scroll-up
1.78 jmc 994: .El
1.77 lum 995: .Sh MG DIRED COMMANDS
996: The following are a list of the commands specific to dired mode:
997: .Bl -tag -width Ds
998: .It dired-create-directory
999: Create a directory.
1.82 lum 1000: .It dired-do-copy
1001: Copy the file listed on the current line of the dired buffer.
1002: .It dired-do-flagged-delete
1.77 lum 1003: Delete the files that have been flagged for deletion.
1.82 lum 1004: .It dired-do-rename
1005: Rename the file listed on the current line of the dired buffer.
1.101 lum 1006: .It dired-find-alternate-file
1007: Replace the current dired buffer with an alternate one as specified
1008: by the position of the cursor in the dired buffer.
1.77 lum 1009: .It dired-find-file
1010: Open the file on the current line of the dired buffer.
1.78 jmc 1011: If the cursor is on a directory it will be opened in dired mode.
1.82 lum 1012: .It dired-flag-file-deletion
1.77 lum 1013: Flag the file listed on the current line for deletion.
1014: This is indicated in the buffer by putting a D at the left margin.
1.91 lum 1015: No files are actually deleted until the function dired-do-flagged-delete
1.77 lum 1016: is executed.
1.82 lum 1017: .It dired-find-file-other-window
1018: Open the file on the current line of the dired buffer in a
1019: different window.
1.77 lum 1020: .It dired-next-line
1021: Move the cursor to the next line.
1022: .It dired-other-window
1023: This function works just like dired, except that it puts the
1024: dired buffer in another window.
1025: .It dired-previous-line
1026: Move the cursor to the previous line.
1.84 lum 1027: .It dired-revert
1.108 lum 1028: Refresh the dired buffer while retaining any flags.
1.77 lum 1029: .It dired-scroll-down
1030: Scroll down the dired buffer.
1031: .It dired-scroll-up
1032: Scroll up the dired buffer.
1.82 lum 1033: .It dired-unmark
1.77 lum 1034: Remove the deletion flag for the file on the current line.
1.82 lum 1035: .It dired-unmark-backward
1.85 lum 1036: Remove the deletion flag from the file listed on the previous line
1037: of the dired buffer, then move up to that line.
1.83 lum 1038: .It quit-window
1039: Close the current dired buffer.
1.37 kjell 1040: .El
1.33 kjell 1041: .Sh CONFIGURATION FILES
1.7 aaron 1042: There are two configuration files,
1.65 jmc 1043: .Pa .mg
1.1 deraadt 1044: and
1.3 aaron 1045: .Pa .mg-TERM .
1046: Here,
1047: .Ev TERM
1.65 jmc 1048: represents the name of the terminal type; e.g. if the terminal type
1.3 aaron 1049: is set to
1050: .Dq vt100 ,
1.2 deraadt 1051: .Nm
1.1 deraadt 1052: will use
1.3 aaron 1053: .Pa .mg-vt100
1.6 aaron 1054: as a startup file.
1055: The terminal type startup file is used first.
1.33 kjell 1056: .Pp
1.28 jmc 1057: The startup file format is a list of commands, one per line, as used for
1.33 kjell 1058: interactive evaluation.
1059: Strings that are normally entered by the user at any subsequent prompts
1060: may be specified after the command name; e.g.:
1.28 jmc 1061: .Bd -literal -offset indent
1.37 kjell 1062: global-set-key ")" self-insert-command
1.46 jmc 1063: global-set-key "\e^x\e^f" find-file
1064: global-set-key "\ee[Z" backward-char
1.37 kjell 1065: set-default-mode fill
1.28 jmc 1066: set-fill-column 72
1.37 kjell 1067: auto-execute *.c c-mode
1.28 jmc 1068: .Ed
1.88 lum 1069: .Pp
1070: Comments can be added to the startup files by placing
1071: .Dq \;
1072: or
1073: .Dq #
1074: as the first character of a line.
1.3 aaron 1075: .Sh FILES
1.55 lum 1076: .Bl -tag -width /usr/share/doc/mg/tutorial -compact
1.3 aaron 1077: .It Pa ~/.mg
1078: normal startup file
1079: .It Pa ~/.mg-TERM
1080: terminal-specific startup file
1.63 lum 1081: .It Pa ~/.mg.d
1082: alternative backup file location
1.52 lum 1083: .It Pa /usr/share/doc/mg/tutorial
1.51 lum 1084: concise tutorial
1.3 aaron 1085: .El
1086: .Sh SEE ALSO
1.56 lum 1087: .Xr ctags 1 ,
1.2 deraadt 1088: .Xr vi 1
1.29 reyk 1089: .Sh CAVEATS
1.37 kjell 1090: Since it is written completely in C, there is currently no
1.54 lum 1091: language in which extensions can be written;
1092: however, keys can be rebound and certain parameters can be changed
1.38 kjell 1093: in startup files.
1.33 kjell 1094: .Pp
1095: In order to use 8-bit characters (such as German umlauts), the Meta key
1096: needs to be disabled via the
1097: .Dq meta-key-mode
1098: command.
1.75 naddy 1099: .Pp
1100: 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