commit a6da3757abe2a182993876fdf7de26632eca8c9b
parent 351f8205de780100d4d584e299aed39234a6d036
Author: Rafael Garcia <rafael.garcia.gallego@gmail.com>
Date: Thu, 2 Jun 2011 10:44:00 +0200
Mercurial oops
Diffstat:
| sandy.1 | | | 117 | +++++++++++++++++++++++++++++++++++++++++++++++-------------------------------- |
1 file changed, 70 insertions(+), 47 deletions(-)
diff --git a/sandy.1 b/sandy.1
@@ -3,95 +3,118 @@
sandy \- simple ncurses text editor
.SH SYNOPSIS
.B sandy
-.RB [ \-hrS ]
-.RB [ \-t\ tabstop ]
-.RB [ \-s\ syntax ]
-.RB [File | -]
+.RB [ \-hruS ]
+.RB [ \-t
+.IR tabstop ]
+.RB [ \-s
+.IR syntax ]
+.RI [ file |-]
.SH DESCRIPTION
-sandy is a simple ncurses Text Editor. It loads and saves files and lets you perform basic editing and pipe the selection through arbitrary commands. A small degree of external control can be achieved by writing to a named pipe.
+sandy is a simple ncurses text editor. It loads and saves files and lets you
+perform basic editing and pipe the selection through arbitrary commands. A small
+degree of external control can be achieved by writing to a named pipe.
.SH OPTIONS
.TP
.B \-h
-Prints usage information to standard output, then exits.
+Prints usage information to stdout, then exits.
.TP
.B \-r
Opens the selected file read-only.
.TP
-.B \-s syntax
+.BI \-s " syntax"
Manually choose the syntax colors.
.TP
.B \-S
Use no syntax colors at all.
.TP
-.B \-t tabstop
+.BI \-t " tabstop"
Use selected tabstop in characters.
.TP
.B \-v
-Prints version information to standard output, then exits.
+Prints version information to stdout, then exits.
.SH USAGE
-The default key-bindings try to stick to the "emacs-mode" present in modern shells (specifically mksh(1)), ignoring binding chains and replacing or removing all meta bindings. External input is handled using dmenu(1) if the DISPLAY environment variable is set, read using sh(1) otherwise. Similarly, X11 clipboard interaction occurs through xsel(1) if DISPLAY is set, using a hidden file in the HOME directory otherwise.
+The default key-bindings try to stick to the "emacs-mode" present in modern
+shells (specifically
+.IR mksh (1)),
+which actually differs a bit from what
+.IR emacs (1)
+does. External input is handled using
+.IR dmenu (1)
+if the DISPLAY environment variable is set, read using
+.IR sh (1)
+otherwise. Similarly, X11 clipboard interaction occurs through
+.IR xsel (1)
+if DISPLAY is set, using a hidden file in the HOME directory otherwise.
.SS Cursor movement
-Cursor movement bindings can also be used to select text by pressing Ctrl\-g to start a selection (see below)
+Cursor movement bindings can also be used to select text by pressing Ctrl\-g to
+start a selection (see below)
.TP
-.B Ctrl\-f or Right
+.BR Ctrl\-f " or " Right
Move cursor to next char.
.TP
-.B Ctrl\-b or Left
+.BR Ctrl\-b " or " Left
Move cursor to previous char.
.TP
-.B Ctrl\-n or Down
+.BR Ctrl\-n " or " Down
Move cursor to next line.
.TP
-.B Ctrl\-p or Up
+.BR Ctrl\-p " or " Up
Move cursor to previous line.
.TP
-.B Shift\-Right
-Move cursor to the end of this or next word.
+.BR Shift\-Right
+Move cursor to the end of this " or " next word.
.TP
-.B Shift\-Left
-Move cursor to the start of this or previous word.
+.BR Shift\-Left
+Move cursor to the start of this " or " previous word.
.TP
-.B Ctrl\-a or Home
-Move cursor to the beginning of the current line or, if already there, one full screen up.
+.BR Ctrl\-a " or " Home
+Move cursor to the beginning of the current line " or " if already there, one
+full screen up.
.TP
-.B Ctrl\-e or End
-Move cursor to the end of the current line or, if already there, one full screen down.
+.BR Ctrl\-e " or " End
+Move cursor to the end of the current line " or " if alredy there, one full
+screen down.
.TP
-.B Prev
+.BR Prev
Move cursor one full screen up.
.TP
-.B Next
+.BR Next
Move cursor one full screen down.
.TP
-.B Shift-Home
+.BR Shift-Home
Move cursor to the beginning of the file.
.TP
-.B Shift-End
+.BR Shift-End
Move cursor to the end of the file.
.SS Finding and selecting
Text is searched and selected using POSIX regular expressions
.TP
.B Ctrl\-s
-Prompt for a search regex forward or, if text is already selected, repeat last search forward.
+Prompt for a search regex forward " or " if there is a selection, repeat
+search forward.
.TP
.B Ctrl\-r
-Prompt for a search regex backwards or, if text is already selected, repeat last search backwards.
+Prompt for a search regex backwards " or " if there is a selection, repeat
+search backwards.
.TP
-.B Ctrl\-]
+.B Ctrl\-\]
Extend selection to word, line, or full file from current.
.TP
.B Ctrl\-g
Cancel selection, or start selecting text manually.
.TP
.B Ctrl\-o
-Move to the opposite size of the selection, usually to change it (move to the mark if no selection).
+Move to the opposite size of the selection, usually to change it " or " if
+there is no selection, move to mark.
.SS Deleting
-If any text is selected, any of these bindings deletes it and, unless Backspace or Delete, moves it to the clipboard. Otherwise they behave as per this text. In read-only mode, these bindings select text instead.
+If any text is selected, any of these bindings deletes it and, unless Backspace
+or Delete, moves it to the clipboard. Otherwise they behave as per this text.
+In read-only mode, these bindings select text instead.
.TP
-.B Ctrl\-d or Delete
+.BR Ctrl\-d " or " Delete
Delete next character.
.TP
-.B Ctrl\-h or Backspace
+.BR Ctrl\-h " or " Backspace
Delete previous character.
.TP
.B Ctrl\-u
@@ -108,28 +131,28 @@ Delete to end of word or next word.
.SS Mark
The mark is a single fixed position in the file that can be used as bookmark.
.TP
-.B Ctrl\-Space or Ctrl\-\@
+.B Ctrl\-Space " or " Ctrl\-`
Set mark in current position.
.TP
-.B Ctrl\-o
-Go to mark (unless there is a selection). Prepend with Ctrl\-g to select to mark.
+.BR Ctrl\-o
+Go to mark unless there is a selection. Prepend with Ctrl\-g to select to mark.
.SS File operations
.TP
-.B Ctrl-q
-Quit if the file has not been modified. Repeat to force quit.
+.BR Ctrl-q
+Quit if the file has not been modified. Repeat to quit unconditionally.
.TP
.B Ctrl\-x
-Write changes to disk or quit if unmodified.
+Write changes to disk " or " quit if the file is not modified.
.SS Text operations
These operations affect the selected text if any.
.TP
.B Ctrl\-\\
Prompt for a command to pipe text through.
.TP
-.B Ctrl\-y or Shift-Insert
+.BR Ctrl\-y " or " Shift-Insert
Replace (paste, yank) with text from the clipboard.
.TP
-.B Ctrl\-t or Insert
+.BR Ctrl\-t " or " Insert
Copy to the clipboard.
.TP
.B Shift-Delete
@@ -143,12 +166,12 @@ Center screen in current line, refresh.
Insert next character as-is.
.TP
.B Ctrl\-z
-Suspend editor to the shell.
+Suspend editor to shell.
.TP
-.B Ctrl\-\[ or Escape
-Prompt for a command or line number to go to.
+.B Ctrl\-\[ " or " Esc
+Prompt for command.
.SH SEE ALSO
-.BR dmenu(1)
-.BR xsel(1)
+.IR dmenu (1),
+.IR xsel (1)
.SH BUGS
Please report them!
