From: Michael D. Lowis Date: Mon, 27 Mar 2017 15:13:55 +0000 (-0400) Subject: Updated edit and xpick man pages X-Git-Url: https://git.mdlowis.com/?a=commitdiff_plain;h=d01d36b363513054cc9c9c66fa7304ed66a6be99;p=projs%2Ftide.git Updated edit and xpick man pages --- diff --git a/docs/edit.1 b/docs/edit.1 index fb9e909..f41ba60 100644 --- a/docs/edit.1 +++ b/docs/edit.1 @@ -13,25 +13,28 @@ 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" -. -.SS "$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) . .SH "ENVIRONMENT" . -.SS "BASH_ENV" +.TP +\fBBASH_ENV\fR 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) . -.SS "DISPLAY" +.TP +\fBDISPLAY\fR 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\. . -.SS "EDITRCFILE" +.TP +\fBEDITRCFILE\fR 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\. . -.SS "EDITOR" +.TP +\fBEDITOR\fR Used as a fallback for when not running in an X11 system (xedit(1) is of course X11 only)\. . -.SS "PATH" +.TP +\fBPATH\fR 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\. . .SH "AUTHOR" diff --git a/docs/edit.1.md b/docs/edit.1.md index c495ff0..dd5858a 100644 --- a/docs/edit.1.md +++ b/docs/edit.1.md @@ -13,35 +13,35 @@ 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) ## 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. +* `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 @@ -50,4 +50,3 @@ Michael D. Lowis ## SEE ALSO xedit(1) xpick(1) xfilepick(1) xtagpick(1) - diff --git a/docs/xpick.1 b/docs/xpick.1 index 2d22965..d99beb0 100644 --- a/docs/xpick.1 +++ b/docs/xpick.1 @@ -7,20 +7,22 @@ \fBxpick\fR \- fuzzy find an item from a list of items . .SH "SYNOPSIS" +\fBxpick\fR [\fIquery\fR] . .SH "DESCRIPTION" +\fBxpick\fR Takes a list of items on standard input delimited by newlines and an optional initial \fIquery\fR\. A gui window is then presented to the user which allows the user to filter the list using a fuzzy\-find algorithm\. The user\'s selection is printed to standard output upon completion\. If no option is selected \fBxpick\fR exits with no output\. . -.SH "OPTIONS" -. -.SH "FILES" +.SS "Fuzzy\-Find Algorithm" +TODO: Document this . .SH "ENVIRONMENT" . -.SH "DIAGNOSTICS" -. -.SH "BUGS" +.TP +\fBXPICKTITLE\fR +If this variable is set its contents are used to populate the status region of the \fBxpick\fR window\. . .SH "AUTHOR" +Michael D\. Lowis . .SH "SEE ALSO" - +xedit(1) xpick(1) xfilepick(1) xtagpick(1) diff --git a/docs/xpick.1.md b/docs/xpick.1.md index 072437e..4037c3c 100644 --- a/docs/xpick.1.md +++ b/docs/xpick.1.md @@ -1,10 +1,31 @@ # xpick -- fuzzy find an item from a list of items + ## SYNOPSIS + +`xpick` [] + ## DESCRIPTION -## OPTIONS -## FILES + +`xpick` Takes a list of items on standard input delimited by newlines and an +optional initial . A gui window is then presented to the user which +allows the user to filter the list using a fuzzy-find algorithm. The user's +selection is printed to standard output upon completion. If no option is +selected `xpick` exits with no output. + +### Fuzzy-Find Algorithm + +TODO: Document this + ## ENVIRONMENT -## DIAGNOSTICS -## BUGS + +* `XPICKTITLE`: + If this variable is set its contents are used to populate the status region + of the `xpick` window. + ## AUTHOR + +Michael D. Lowis + ## SEE ALSO + +xedit(1) xpick(1) xfilepick(1) xtagpick(1)