Updated man page documentation for edit and xedit

diff --git a/docs/edit.1 b/docs/edit.1
index eee9e25ba1f44100e401d23b3f910ba1a7568fec..9c17e58a42382da5c7ef823f6c6fd1dc11104dfd 100644 (file)
--- a/docs/edit.1
+++ b/docs/edit.1
@@ -15,7 +15,7 @@ This script acts as a wrapper around xedit(1)\. It is responsible for setting up
 .SH "FILES"
 .
 .TP
-$HOME/\.config/edit/editrc
+\fB$HOME/\.config/edit/editrc\fR
 Shell script loaded in current environment to make shell functions and environment variables available to xedit(1)
 .
 .SH "ENVIRONMENT"

diff --git a/docs/edit.1.md b/docs/edit.1.md
index e7a4c791c857b638343e5b42963d222873cacbcb..abec4e72a8fd81af3b4b84c58543ad9be2c5f129 100644 (file)
--- a/docs/edit.1.md
+++ b/docs/edit.1.md
@@ -13,7 +13,7 @@ are provided, xedit(1) will be launched to edit a scratch buffer.
 
 ## FILES
 
-* $HOME/.config/edit/editrc:
+* `$HOME/.config/edit/editrc`:
     Shell script loaded in current environment to make shell functions and 
     environment variables available to xedit(1)
 

diff --git a/docs/xedit.1 b/docs/xedit.1
index 20e83f1ee12624fa0491e22022083fdcae9fbcb8..11b48d239a78e4edc2cc4415001567395e6018f7 100644 (file)
--- a/docs/xedit.1
+++ b/docs/xedit.1
@@ -1,23 +1,19 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "XEDIT" "1" "March 2017" "" ""
+.TH "XEDIT" "1" "April 2017" "" ""
 .
 .SH "NAME"
 \fBxedit\fR \- a text editor inspired by Acme from Plan 9 and Inferno
 .
 .SH "SYNOPSIS"
-.
-.nf
-
-`xedit` [<file>]
-.
-.fi
+\fBxedit\fR [\fIfile\fR]
 .
 .SH "DESCRIPTION"
 \fBxedit\fR is a text editor inspired by the Acme editor from the Plan 9 and Inferno operating systems\. Unlike Acme, \fBxedit\fR 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 \fBxedit\fR 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\.
 .
 .SS "Windows"
+\fBxedit\fR 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\.
 .
 .SS "Scrolling"
 .
@@ -25,12 +21,108 @@
 .
 .SH "MOUSE HANDLING"
 .
+.SH "COMMAND EXECUTION"
+.
 .SH "KEYBOARD SHORTCUTS"
 .
-.SH "COMMAND EXECUTION"
+.TP
+\fBCtrl+u\fR:
+
+.
+.TP
+\fBCtrl+k\fR:
+
+.
+.TP
+\fBCtrl+w\fR:
+
+.
+.TP
+\fBCtrl+a\fR:
+
+.
+.TP
+\fBCtrl+e\fR:
+
+.
+.TP
+\fBCtrl+s\fR:
+
+.
+.TP
+\fBCtrl+z\fR:
+
+.
+.TP
+\fBCtrl+y\fR:
+
+.
+.TP
+\fBCtrl+x\fR:
+
+.
+.TP
+\fBCtrl+c\fR:
+
+.
+.TP
+\fBCtrl+v\fR:
+
+.
+.TP
+\fBCtrl+[\fR:
+
+.
+.TP
+\fBCtrl+]\fR:
+
 .
 .SH "BUILTINS"
 .
+.TP
+\fBCut\fR
+Cut the selection to the X11 CLIPBOARD selection\.
+.
+.TP
+\fBCopy\fR
+Copy the selection to the X11 CLIPBOARD selection\.
+.
+.TP
+\fBEol\fR
+Toggle the line\-ending style for the buffers contents between LF and CRLF
+.
+.TP
+\fBFind\fR
+Find the next occurrence of the selected text\.
+.
+.TP
+\fBIndent\fR
+Toggle the autoindent feature on or off\.
+.
+.TP
+\fBPaste\fR
+Paste the contents of the X11 CLIPBOARD selection into the buffer\.
+.
+.TP
+\fBQuit\fR
+Quit the editor\.
+.
+.TP
+\fBRedo\fR
+Redo the last undone change\.
+.
+.TP
+\fBSave\fR
+Save the contents of the buffer to disk\.
+.
+.TP
+\fBTabs\fR
+Toggle the expand tabs featuer on or off\.
+.
+.TP
+\fBUndo\fR
+Undo the previous edit\.
+.
 .SH "FILES"
 .
 .TP

diff --git a/docs/xedit.1.md b/docs/xedit.1.md
index ae1c4917798357a927a01db08f4793f1afc6f021..3e449f50fcb5d8e923cdf2a31ef69c604c1aadb5 100644 (file)
--- a/docs/xedit.1.md
+++ b/docs/xedit.1.md
@@ -14,13 +14,67 @@ 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
 
 ## MOUSE HANDLING
-## KEYBOARD SHORTCUTS
 ## COMMAND EXECUTION
+
+## KEYBOARD SHORTCUTS
+
+* `Ctrl+u`:
+* `Ctrl+k`:
+* `Ctrl+w`:
+* `Ctrl+a`:
+* `Ctrl+e`:
+
+* `Ctrl+s`:
+* `Ctrl+z`:
+* `Ctrl+y`:
+* `Ctrl+x`:
+* `Ctrl+c`:
+* `Ctrl+v`:
+
+* `Ctrl+[`:
+* `Ctrl+]`:
+
 ## 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`: