.
.SS "Typing"
.
+.SH "TEXT SELECTION"
+.
.SH "MOUSE HANDLING"
.
.SH "COMMAND EXECUTION"
.
.SH "KEYBOARD SHORTCUTS"
.
+.SS "Unix Standard Shortcuts"
+.
+.TP
+\fBCtrl+u\fR
+Delete from the cursor position to the beginning of the line\.
+.
+.TP
+\fBCtrl+k\fR
+Delete from the cursor position to the end of the line\.
+.
+.TP
+\fBCtrl+w\fR
+Delete the word to the left\.
+.
+.TP
+\fBCtrl+a\fR
+Move cursor to the beginning of the line\.
+.
+.TP
+\fBCtrl+e\fR
+Move cursor to the end of the line\.
+.
+.TP
+\fBCtrl+h\fR
+Delete the cursor to the left\.
+.
+.SS "Cursor Movement and Selection"
+The key combinations below are responsible for moving the cursor around the document by character, by word, or by line\. The \fBShift\fR modifier key can be applied to any of them to also extend the current selection to the new cursor position\.
+.
+.TP
+\fBEscape\fR
+Highlight the last contiguous block of inserted text or clear the current selection (deselect the currently selected text)\.
+.
+.TP
+\fBLeft\fR
+Move the cursor one character to the left\.
+.
+.TP
+\fBRight\fR
+Move the cursor one character to the right\.
+.
+.TP
+\fBUp\fR
+Move the cursor to theprevious line\.
+.
+.TP
+\fBDown\fR
+Move the cursor to the next line\.
+.
+.TP
+\fBCtrl+Left\fR
+Move the cursor to the beginning of the word to the left\.
+.
+.TP
+\fBCtrl+Right\fR
+Move the cursor to the end of the word to the right\.
+.
+.SS "Modern Text Editing Shortcuts"
+.
+.TP
+\fBCtrl+s\fR
+Save the contents of the content region to disk\.
+.
+.TP
+\fBCtrl+z\fR
+Undo the last change performed on the active region\.
+.
+.TP
+\fBCtrl+y\fR
+Redo the previously undone change on the active region\.
+.
.TP
-\fBCtrl+u\fR:
-
+\fBCtrl+x\fR
+Cut the selected text to the X11 CLIPBOARD selection\.
.
.TP
-\fBCtrl+k\fR:
-
+\fBCtrl+c\fR
+Copy the selected text to the X11 CLIPBOARD selection\.
.
.TP
-\fBCtrl+w\fR:
-
+\fBCtrl+v\fR
+Paste the contents of the X11 CLIPBOARD selection to the active region\.
.
.TP
-\fBCtrl+a\fR:
-
+\fBDelete\fR
+Delete the character to the right\.
.
.TP
-\fBCtrl+e\fR:
-
+\fBCtrl+Delete\fR
+Delete the word to the right\.
.
.TP
-\fBCtrl+s\fR:
-
+\fBBackspace\fR
+Delete the character to the left\.
.
.TP
-\fBCtrl+z\fR:
-
+\fBCtrl+Backspace\fR
+Delete the word to the left\.
.
.TP
-\fBCtrl+y\fR:
-
+\fBCtrl+Enter\fR
+Create a new line after the current line and place the cursor there\.
.
.TP
-\fBCtrl+x\fR:
-
+\fBCtrl+Shift+Enter\fR
+Create a new line before the current line and place the cursor there\.
.
.TP
-\fBCtrl+c\fR:
-
+\fBPageUp\fR
+Scroll the active region up by one screenful of text\. The cursor is not affected by this operation\.
+.
+.TP
+\fBPageDn\fR
+Scroll the active region down by one screenful of text\. The cursor is not affected by this operation\.
+.
+.SS "Search Shortcuts"
+The shortcuts below allow the user to search for selected text or by context\. The direction of the search defaults to the forward direction with regard to the position in the file\. Each search follows the direction of the previous search unless the \fBShift\fR modifier is applied\. The \fBShift\fR modifier causes the current search operation to be applied in the opposite direction of the previous\.
+.
+.TP
+\fBCtrl+f\fR
+Search for the next occurrence of the selected text in the content region\. If no text is currently selected, the text under the cursor is selected based on context as described in \fBTEXT SELECTION\fR\.
+.
+.TP
+\fBCtrl+Alt+f\fR
+Search for the next occurence previous search term in the content region\.
+.
+.SS "Implementation\-specific Shortcuts"
.
.TP
-\fBCtrl+v\fR:
-
+\fBCtrl+[\fR
+Decrease the indent level of the selected text\.
.
.TP
-\fBCtrl+[\fR:
-
+\fBCtrl+]\fR
+Increase the indent level of the selected text\.
.
.TP
-\fBCtrl+]\fR:
-
+\fBCtrl+t\fR
+Toggle focus between the tags region and the content region\.
+.
+.TP
+\fBCtrl+q\fR
+Quit the editor\. If the file is modified a warning will be printed in the tags region and the editor will not quit\. Executing the shortcut twice within 250ms will ignore the warning and quit the editor without saving\.
+.
+.TP
+\fBCtrl+d\fR
+Execute the selected text as described in \fBCOMMAND EXECUTION\fR\. If no text is selected, the text under cursor is selecte dbased on context as described in \fBTEXT SELECTION\fR\.
+.
+.TP
+\fBCtrl+o\fR
+Launch xfilepick(1) to choose a file from a recursive list of files in the current deirectory and sub directories\. This file will be opened in a new instance of \fBxedit\fR\.
+.
+.TP
+\fBCtrl+p\fR
+Launch xtagpick(1) to select a tag from a ctags(1) generated index file\. \fBxedit\fR will jump to the selected ctag definition in the current window if the file is currently being edited\. Otherwise, a new instance of \fBxedit\fR will be launched with the target file and the cursor set to the line containing the definition\.
+.
+.TP
+\fBCtrl+g\fR
+Lookup the selected symbol or symbol under the cursor in a ctags(1) generated index file\. Jump to the location of the definition if it exist in the current file\. Otherwise, a new instance of \fBxedit\fR will be launched with the target file and the cursor set to the line containing the definition\.
+.
+.TP
+\fBCtrl+n\fR
+Open a new instance of \fBxedit\fR with no filename\.
.
.SH "BUILTINS"
.
.
.SH "ENVIRONMENT"
.
+.TP
+\fBSHELL\fR
+The contents of this variable are used as the shell in which all non\-builtin commands are executed\. If this variable is not defined, sh(1) is used as a fallback shell\.
+.
.SH "BUGS"
.
.SH "AUTHOR"
### Windows
-`xedit` windows are divided into four basic regions: a one-line status, an
-expanding tags region, a main content region and an adjacent scroll region. The
-status region contains a set of symbolic flags indicating the current state of
-the editor followed by the path of the file being edited. The tags region acts
+`xedit` windows are divided into four basic regions: a one-line status, an
+expanding tags region, a main content region and an adjacent scroll region. The
+status region contains a set of symbolic flags indicating the current state of
+the editor followed by the path of the file being edited. The tags region acts
as scratch buffer for commands that can be executed to affect the file or the
state of the editor. As the content of this region grows it will expand up to a
-quarter of the size of the window shrinking the main coantent region in kind.
+quarter of the size of the window shrinking the main coantent region in kind.
The main content region displays a view of the file currently being edited. To
the left of the content region is a narrow vertical region matching the height
-of the content region. This region acts as a scrollbar for the content region.
+of the content region. This region acts as a scrollbar for the content region.
### Scrolling
### Typing
+## TEXT SELECTION
## MOUSE HANDLING
## COMMAND EXECUTION
## KEYBOARD SHORTCUTS
+### Unix Standard Shortcuts
+
* `Ctrl+u`:
+ Delete from the cursor position to the beginning of the line.
* `Ctrl+k`:
+ Delete from the cursor position to the end of the line.
* `Ctrl+w`:
+ Delete the word to the left.
* `Ctrl+a`:
+ Move cursor to the beginning of the line.
* `Ctrl+e`:
+ Move cursor to the end of the line.
+* `Ctrl+h`:
+ Delete the cursor to the left.
+
+### Cursor Movement and Selection
+
+The key combinations below are responsible for moving the cursor around the
+document by character, by word, or by line. The `Shift` modifier key can be
+applied to any of them to also extend the current selection to the new cursor
+position.
+
+* `Escape`:
+ Highlight the last contiguous block of inserted text or clear the current
+ selection (deselect the currently selected text).
+* `Left`:
+ Move the cursor one character to the left.
+* `Right`:
+ Move the cursor one character to the right.
+* `Up`:
+ Move the cursor to theprevious line.
+* `Down`:
+ Move the cursor to the next line.
+* `Ctrl+Left`:
+ Move the cursor to the beginning of the word to the left.
+* `Ctrl+Right`:
+ Move the cursor to the end of the word to the right.
+
+### Modern Text Editing Shortcuts
* `Ctrl+s`:
+ Save the contents of the content region to disk.
* `Ctrl+z`:
+ Undo the last change performed on the active region.
* `Ctrl+y`:
+ Redo the previously undone change on the active region.
* `Ctrl+x`:
+ Cut the selected text to the X11 CLIPBOARD selection.
* `Ctrl+c`:
+ Copy the selected text to the X11 CLIPBOARD selection.
* `Ctrl+v`:
+ Paste the contents of the X11 CLIPBOARD selection to the active region.
+* `Delete`:
+ Delete the character to the right.
+* `Ctrl+Delete`:
+ Delete the word to the right.
+* `Backspace`:
+ Delete the character to the left.
+* `Ctrl+Backspace`:
+ Delete the word to the left.
+* `Ctrl+Enter`:
+ Create a new line after the current line and place the cursor there.
+* `Ctrl+Shift+Enter`:
+ Create a new line before the current line and place the cursor there.
+* `PageUp`:
+ Scroll the active region up by one screenful of text. The cursor is not
+ affected by this operation.
+* `PageDn`:
+ Scroll the active region down by one screenful of text. The cursor is not
+ affected by this operation.
+
+### Search Shortcuts
+
+The shortcuts below allow the user to search for selected text or by context.
+The direction of the search defaults to the forward direction with regard to the
+position in the file. Each search follows the direction of the previous search
+unless the `Shift` modifier is applied. The `Shift` modifier causes the current
+search operation to be applied in the opposite direction of the previous.
+
+* `Ctrl+f`:
+ Search for the next occurrence of the selected text in the content region.
+ If no text is currently selected, the text under the cursor is selected
+ based on context as described in `TEXT SELECTION`.
+* `Ctrl+Alt+f`:
+ Search for the next occurence previous search term in the content region.
+
+### Implementation-specific Shortcuts
* `Ctrl+[`:
+ Decrease the indent level of the selected text.
* `Ctrl+]`:
+ Increase the indent level of the selected text.
+* `Ctrl+t`:
+ Toggle focus between the tags region and the content region.
+* `Ctrl+q`:
+ Quit the editor. If the file is modified a warning will be printed in the
+ tags region and the editor will not quit. Executing the shortcut twice
+ within 250ms will ignore the warning and quit the editor without saving.
+* `Ctrl+d`:
+ Execute the selected text as described in `COMMAND EXECUTION`. If no text
+ is selected, the text under cursor is selecte dbased on context as described
+ in `TEXT SELECTION`.
+* `Ctrl+o`:
+ Launch xfilepick(1) to choose a file from a recursive list of files in the
+ current deirectory and sub directories. This file will be opened in a
+ new instance of `xedit`.
+* `Ctrl+p`:
+ Launch xtagpick(1) to select a tag from a ctags(1) generated index file.
+ `xedit` will jump to the selected ctag definition in the current window if
+ the file is currently being edited. Otherwise, a new instance of `xedit`
+ will be launched with the target file and the cursor set to the line
+ containing the definition.
+* `Ctrl+g`:
+ Lookup the selected symbol or symbol under the cursor in a ctags(1)
+ generated index file. Jump to the location of the definition if it exist in
+ the current file. Otherwise, a new instance of `xedit` will be launched with
+ the target file and the cursor set to the line containing the definition.
+* `Ctrl+n`:
+ Open a new instance of `xedit` with no filename.
## BUILTINS
-* `Cut`:
+* `Cut`:
Cut the selection to the X11 CLIPBOARD selection.
-* `Copy`:
+* `Copy`:
Copy the selection to the X11 CLIPBOARD selection.
-* `Eol`:
+* `Eol`:
Toggle the line-ending style for the buffers contents between LF and CRLF
* `Find`:
Find the next occurrence of the selected text.
## FILES
* `$HOME/.config/edit/editrc`:
- Shell script loaded in current environment to make shell functions and
+ Shell script loaded in current environment to make shell functions and
environment variables available to xedit(1)
## ENVIRONMENT
+* `SHELL`:
+ The contents of this variable are used as the shell in which all non-builtin
+ commands are executed. If this variable is not defined, sh(1) is used
+ as a fallback shell.
+
## BUGS
## AUTHOR
--- /dev/null
+# xedit -- a text editor inspired by Acme from Plan 9 and Inferno
+
+## SYNOPSIS
+
+`xedit` [_file_]
+
+## DESCRIPTION
+
+`xedit` is a text editor inspired by the Acme editor from the Plan 9 and Inferno
+operating systems. Unlike Acme, `xedit` is a single window, single file editor.
+Instead of baking a window manager into the editor, this job is relegated to an
+X11 window manager. It is recommended that `xedit` be used with a tiling window
+manager such as dwm(1) or spectrwm(1). These window managers will make dealing
+with multiple windows much easier and more efficient.
+
+### Windows
+
+`xedit` windows are divided into four basic regions: a one-line status, an
+expanding tags region, a main content region and an adjacent scroll region. The
+status region contains a set of symbolic flags indicating the current state of
+the editor followed by the path of the file being edited. The tags region acts
+as scratch buffer for commands that can be executed to affect the file or the
+state of the editor. As the content of this region grows it will expand up to a
+quarter of the size of the window shrinking the main coantent region in kind.
+The main content region displays a view of the file currently being edited. To
+the left of the content region is a narrow vertical region matching the height
+of the content region. This region acts as a scrollbar for the content region.
+
+### Scrolling
+### Typing
+
+## TEXT SELECTION
+## MOUSE HANDLING
+## COMMAND EXECUTION
+
+## KEYBOARD SHORTCUTS
+
+### Unix Standard Shortcuts
+
+* `Ctrl+u`:
+ Delete from the cursor position to the beginning of the line.
+* `Ctrl+k`:
+ Delete from the cursor position to the end of the line.
+* `Ctrl+w`:
+ Delete the word to the left.
+* `Ctrl+a`:
+ Move cursor to the beginning of the line.
+* `Ctrl+e`:
+ Move cursor to the end of the line.
+* `Ctrl+h`:
+ Delete the cursor to the left.
+
+### Cursor Movement and Selection
+
+The key combinations below are responsible for moving the cursor around the
+document by character, by word, or by line. The `Shift` modifier key can be
+applied to any of them to also extend the current selection to the new cursor
+position.
+
+* `Escape`:
+ Highlight the last contiguous block of inserted text or clear the current
+ selection (deselect the currently selected text).
+* `Left`:
+ Move the cursor one character to the left.
+* `Right`:
+ Move the cursor one character to the right.
+* `Up`:
+ Move the cursor to theprevious line.
+* `Down`:
+ Move the cursor to the next line.
+* `Ctrl+Left`:
+ Move the cursor to the beginning of the word to the left.
+* `Ctrl+Right`:
+ Move the cursor to the end of the word to the right.
+
+### Modern Text Editing Shortcuts
+
+* `Ctrl+s`:
+ Save the contents of the content region to disk.
+* `Ctrl+z`:
+ Undo the last change performed on the active region.
+* `Ctrl+y`:
+ Redo the previously undone change on the active region.
+* `Ctrl+x`:
+ Cut the selected text to the X11 CLIPBOARD selection.
+* `Ctrl+c`:
+ Copy the selected text to the X11 CLIPBOARD selection.
+* `Ctrl+v`:
+ Paste the contents of the X11 CLIPBOARD selection to the active region.
+* `Delete`:
+ Delete the character to the right.
+* `Ctrl+Delete`:
+ Delete the word to the right.
+* `Backspace`:
+ Delete the character to the left.
+* `Ctrl+Backspace`:
+ Delete the word to the left.
+* `Ctrl+Enter`:
+ Create a new line after the current line and place the cursor there.
+* `Ctrl+Shift+Enter`:
+ Create a new line before the current line and place the cursor there.
+* `PageUp`:
+ Scroll the active region up by one screenful of text. The cursor is not
+ affected by this operation.
+* `PageDn`:
+ Scroll the active region down by one screenful of text. The cursor is not
+ affected by this operation.
+
+### Search Shortcuts
+
+The shortcuts below allow the user to search for selected text or by context.
+The direction of the search defaults to the forward direction with regard to the
+position in the file. Each search follows the direction of the previous search
+unless the `Shift` modifier is applied. The `Shift` modifier causes the current
+search operation to be applied in the opposite direction of the previous.
+
+* `Ctrl+f`:
+ Search for the next occurrence of the selected text in the content region.
+ If no text is currently selected, the text under the cursor is selected
+ based on context as described in `TEXT SELECTION`.
+* `Ctrl+Alt+f`:
+ Search for the next occurence previous search term in the content region.
+
+### Implementation-specific Shortcuts
+
+* `Ctrl+[`:
+ Decrease the indent level of the selected text.
+* `Ctrl+]`:
+ Increase the indent level of the selected text.
+* `Ctrl+t`:
+ Toggle focus between the tags region and the content region.
+* `Ctrl+q`:
+ Quit the editor. If the file is modified a warning will be printed in the
+ tags region and the editor will not quit. Executing the shortcut twice
+ within 250ms will ignore the warning and quit the editor without saving.
+* `Ctrl+d`:
+ Execute the selected text as described in `COMMAND EXECUTION`. If no text
+ is selected, the text under cursor is selecte dbased on context as described
+ in `TEXT SELECTION`.
+* `Ctrl+o`:
+ Launch xfilepick(1) to choose a file from a recursive list of files in the
+ current deirectory and sub directories. This file will be opened in a
+ new instance of `xedit`.
+* `Ctrl+p`:
+ Launch xtagpick(1) to select a tag from a ctags(1) generated index file.
+ `xedit` will jump to the selected ctag definition in the current window if
+ the file is currently being edited. Otherwise, a new instance of `xedit`
+ will be launched with the target file and the cursor set to the line
+ containing the definition.
+* `Ctrl+g`:
+ Lookup the selected symbol or symbol under the cursor in a ctags(1)
+ generated index file. Jump to the location of the definition if it exist in
+ the current file. Otherwise, a new instance of `xedit` will be launched with
+ the target file and the cursor set to the line containing the definition.
+* `Ctrl+n`:
+ Open a new instance of `xedit` with no filename.
+
+## BUILTINS
+
+* `Cut`:
+ Cut the selection to the X11 CLIPBOARD selection.
+* `Copy`:
+ Copy the selection to the X11 CLIPBOARD selection.
+* `Eol`:
+ Toggle the line-ending style for the buffers contents between LF and CRLF
+* `Find`:
+ Find the next occurrence of the selected text.
+* `Indent`:
+ Toggle the autoindent feature on or off.
+* `Paste`:
+ Paste the contents of the X11 CLIPBOARD selection into the buffer.
+* `Quit`:
+ Quit the editor.
+* `Redo`:
+ Redo the last undone change.
+* `Save`:
+ Save the contents of the buffer to disk.
+* `Tabs`:
+ Toggle the expand tabs featuer on or off.
+* `Undo`:
+ Undo the previous edit.
+
+## FILES
+
+* `$HOME/.config/edit/editrc`:
+ Shell script loaded in current environment to make shell functions and
+ environment variables available to xedit(1)
+
+## ENVIRONMENT
+
+* `SHELL`:
+ The contents of this variable are used as the shell in which all non-builtin
+ commands are executed. If this variable is not defined, sh(1) is used
+ as a fallback shell.
+
+## BUGS
+## AUTHOR
+
+Michael D. Lowis
+
+## SEE ALSO
+
+xedit(1) xpick(1) xfilepick(1) xtagpick(1)
projects / projs / tide.git / commitdiff