From c78b71ed641af4c6dcb8854d5e616f86ac654a06 Mon Sep 17 00:00:00 2001 From: "Michael D. Lowis" Date: Mon, 27 Mar 2017 21:37:15 -0400 Subject: [PATCH] started initial work on xedit man page --- docs/edit.1 | 5 ++++- docs/edit.1.md | 31 ++++++++++++++++--------------- docs/xedit.1 | 30 ++++++++++++++++++++++++++---- docs/xedit.1.md | 33 +++++++++++++++++++++++++++++++-- 4 files changed, 77 insertions(+), 22 deletions(-) diff --git a/docs/edit.1 b/docs/edit.1 index f41ba60..eee9e25 100644 --- a/docs/edit.1 +++ b/docs/edit.1 @@ -13,7 +13,10 @@ This script acts as a wrapper around xedit(1)\. It is responsible for setting up the environment variables and loading the rc file xedit(1) before launching a new instance of xedit(1) for each file provided on the command line\. If no files are provided, xedit(1) will be launched to edit a scratch buffer\. . .SH "FILES" -$HOME/\.config/edit/editrc: Shell script loaded in current environment to make shell functions and environment variables available to xedit(1) +. +.TP +$HOME/\.config/edit/editrc +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 134f99a..a5a4b5e 100644 --- a/docs/edit.1.md +++ b/docs/edit.1.md @@ -13,8 +13,9 @@ are provided, xedit(1) will be launched to edit a scratch buffer. ## FILES -$HOME/.config/edit/editrc: -Shell script loaded in current environment to make shell functions and environment variables available to xedit(1) +* $HOME/.config/edit/editrc: + Shell script loaded in current environment to make shell functions and + environment variables available to xedit(1) ## ENVIRONMENT @@ -23,25 +24,25 @@ Shell script loaded in current environment to make shell functions and environme 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. + 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. + 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). + 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. + 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 diff --git a/docs/xedit.1 b/docs/xedit.1 index 83a609b..20e83f1 100644 --- a/docs/xedit.1 +++ b/docs/xedit.1 @@ -8,19 +8,41 @@ . .SH "SYNOPSIS" . +.nf + +`xedit` [] +. +.fi +. .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" +. +.SS "Scrolling" +. +.SS "Typing" . -.SH "OPTIONS" +.SH "MOUSE HANDLING" +. +.SH "KEYBOARD SHORTCUTS" +. +.SH "COMMAND EXECUTION" +. +.SH "BUILTINS" . .SH "FILES" . -.SH "ENVIRONMENT" +.TP +\fB$HOME/\.config/edit/editrc\fR +Shell script loaded in current environment to make shell functions and environment variables available to xedit(1) . -.SH "DIAGNOSTICS" +.SH "ENVIRONMENT" . .SH "BUGS" . .SH "AUTHOR" +Michael D\. Lowis . .SH "SEE ALSO" - +xedit(1) xpick(1) xfilepick(1) xtagpick(1) diff --git a/docs/xedit.1.md b/docs/xedit.1.md index b030aad..d49b21a 100644 --- a/docs/xedit.1.md +++ b/docs/xedit.1.md @@ -1,10 +1,39 @@ # xedit -- a text editor inspired by Acme from Plan 9 and Inferno + ## SYNOPSIS + + `xedit` [] + ## DESCRIPTION -## OPTIONS + +`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 +### Scrolling +### Typing + +## MOUSE HANDLING +## KEYBOARD SHORTCUTS +## COMMAND EXECUTION +## BUILTINS ## FILES + +* `$HOME/.config/edit/editrc`: + Shell script loaded in current environment to make shell functions and + environment variables available to xedit(1) + ## ENVIRONMENT -## DIAGNOSTICS + ## BUGS ## AUTHOR + +Michael D. Lowis + ## SEE ALSO + +xedit(1) xpick(1) xfilepick(1) xtagpick(1) -- 2.49.0