+++ /dev/null
-# edit -- convenience script for launching xedit(1) with a proper environment
-
-## SYNOPSIS
-
-`edit` [_file_...]
-
-## DESCRIPTION
-
-This script acts as a wrapper around xedit(1). It is responsible for setting up
-the environment variables and loading the rc file before launching a
-new instance of xedit(1) to edit the given files. If no files are provided a new
-instance of xedit(1) will be launched with an empty edit buffer.
-
-## FILES
-
-* `$HOME/.config/edit/editrc`:
- Shell script loaded in current environment to make shell functions and
- environment variables available to xedit(1)
-
-## ENVIRONMENT
-
-* `BASH_ENV`:
- Set to same value as $EDITRCFILE so that the file is loaded as a bash script
- in the event that the user shell is bash(1)
-
-* `DISPLAY`:
- This variable is used to determine if we are running in an X11 environment.
- If $DISPLAY is not set then the contents of the $EDITOR variable is used to
- determine what editor to launch in lieu of xedit(1). If $EDITOR is not set
- then vim(1) is launched instead.
-
-* `EDITRCFILE`:
- Contains the path of the shell script which is loaded before xedit(1) to
- setup the environment and define shell functions which can be called during
- an editing session.
-
-* `EDITOR`:
- Used as a fallback for when not running in an X11 system (xedit(1) is of
- course X11 only).
-
-* `PATH`:
- The $PATH variable is modified in order to add $HOME/config/edit/tools/ to
- the path. This folder is a standard location in which user scripts and tools
- can be placed so they can be used from within xedit(1) without cluttering up
- the normal system path.
-
-## AUTHOR
-
-Michael D. Lowis
-
-## SEE ALSO
-
-xedit(1) xpick(1) xfilepick(1) xtagpick(1)
-
+++ /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)