From 396d9bc6d0b170ec996484762804a90ddcb8cb15 Mon Sep 17 00:00:00 2001 From: Natsuo Tsuji Date: Tue, 22 Jan 2013 23:51:34 +0900 Subject: [PATCH] More groff_man-ish coding style --- README | 121 ++++++++++++++++++++++------------------------ z.1 | 150 +++++++++++++++++++++++++++++++-------------------------- 2 files changed, 139 insertions(+), 132 deletions(-) diff --git a/README b/README index 1770501..77c0d40 100644 --- a/README +++ b/README @@ -1,132 +1,127 @@ -Z(1) User Commands Z(1) +Z(1) User Commands Z(1) NAME - z − jump around - + z - jump around SYNOPSIS - z [−h] [−l] [−r] [−t] [regex1 regex2 ... regexn] - + z [-h] [-l] [-r] [-t] [regex1 regex2 ... regexn] AVAILABILITY bash, zsh - DESCRIPTION - Tracks your most used directories, based on ’frecency’. + Tracks your most used directories, based on 'frecency'. - After a short learning phase, z will take you to the most ’frecent’ + After a short learning phase, z will take you to the most 'frecent' directory that matches ALL of the regexes given on the command line. - OPTIONS - −h show a brief help message - −l list only - −r match by rank only - −t match by recent access only + -h show a brief help message + -l list only + + -r match by rank only + + -t match by recent access only EXAMPLES - z foo cd to most frecent dir matching foo - z foo bar cd to most frecent dir matching foo and bar - z ‐r foo cd to highest ranked dir matching foo - z ‐t foo cd to most recently accessed dir matching foo - z ‐l foo list all dirs matching foo (by frecency) + z foo cd to most frecent dir matching foo + z foo bar cd to most frecent dir matching foo and bar -NOTES - Installation: + z -r foo cd to highest ranked dir matching foo + + z -t foo cd to most recently accessed dir matching foo + z -l foo list all dirs matching foo (by frecency) + +NOTES + Installation: Put something like this in your $HOME/.bashrc or $HOME/.zshrc: - . /path/to/z.sh + . /path/to/z.sh cd around for a while to build up the db. PROFIT!! Optionally: - Set $_Z_CMD to change the command name (default z). - Set $_Z_DATA to change the datafile (default $HOME/.z). - Set $_Z_NO_RESOLVE_SYMLINKS to prevent symlink resolution. - Set $_Z_NO_PROMPT_COMMAND to handle PROMPT_COMMAND/precmd yourself. - Set $_Z_EXCLUDE_DIRS to an array of directories to exclude. - (These settings should go in .bashrc/.zshrc before the lines added - above.) - Install the provided man page z.1 somewhere like /usr/local/man/man1. - - Aging: - - The rank of directories maintained by z undergoes aging based on a sim‐ - ple formula. The rank of each entry is incremented every time it is - accessed. When the sum of ranks is greater than 6000, all ranks are + Set $_Z_CMD to change the command name (default z). + Set $_Z_DATA to change the datafile (default $HOME/.z). + Set $_Z_NO_RESOLVE_SYMLINKS to prevent symlink resolution. + Set $_Z_NO_PROMPT_COMMAND to handle PROMPT_COMMAND/precmd your- + self. + Set $_Z_EXCLUDE_DIRS to an array of directories to exclude. + (These settings should go in .bashrc/.zshrc before the lines + added above.) + Install the provided man page z.1 somewhere like + /usr/local/man/man1. + + Aging: + The rank of directories maintained by z undergoes aging based on a sim- + ple formula. The rank of each entry is incremented every time it is + accessed. When the sum of ranks is greater than 6000, all ranks are multiplied by 0.99. Entries with a rank lower than 1 are forgotten. - Frecency: - - Frecency is a portmantaeu of ’recent’ and ’frequency’. It is a weighted - rank that depends on how often and how recently something occured. As + Frecency: + Frecency is a portmantaeu of 'recent' and 'frequency'. It is a weighted + rank that depends on how often and how recently something occured. As far as I know, Mozilla came up with the term. - To z, a directory that has low ranking but has been accessed recently - will quickly have higher rank than a directory accessed frequently a + To z, a directory that has low ranking but has been accessed recently + will quickly have higher rank than a directory accessed frequently a long time ago. Frecency is determined at runtime. - Common: - + Common: When multiple directories match all queries, and they all have a common prefix, z will cd to the shortest matching directory, without regard to - priority. This has been in effect, if undocumented, for quite some + priority. This has been in effect, if undocumented, for quite some time, but should probably be configurable or reconsidered. - Tab Completion - - z supports tab completion. After any number of arguments, press TAB to + Tab Completion: + z supports tab completion. After any number of arguments, press TAB to complete on directories that match each argument. Due to limitations of - the completion implementations, only the last argument will be com‐ + the completion implementations, only the last argument will be com- pleted in the shell. - Internally, z decides you’ve requested a completion if the last argu‐ - ment passed is an absolute path to an existing directory. This may + Internally, z decides you've requested a completion if the last argu- + ment passed is an absolute path to an existing directory. This may cause unexpected behavior if the last argument to z begins with /. - ENVIRONMENT A function _z() is defined. The contents of the variable $_Z_CMD is aliased to _z 2>&1. If not set, $_Z_CMD defaults to z. - The environment variable $_Z_DATA can be used to control the datafile + The environment variable $_Z_DATA can be used to control the datafile location. If it is not defined, the location defaults to $HOME/.z. - The environment variable $_Z_NO_RESOLVE_SYMLINKS can be set to prevent - resolving of symlinks. If it is not set, symbolic links will be + The environment variable $_Z_NO_RESOLVE_SYMLINKS can be set to prevent + resolving of symlinks. If it is not set, symbolic links will be resolved when added to the datafile.. - In bash, z prepends a command to the PROMPT_COMMAND environment vari‐ - able to maintain its database. In zsh, z appends a function _z_precmd + In bash, z prepends a command to the PROMPT_COMMAND environment vari- + able to maintain its database. In zsh, z appends a function _z_precmd to the precmd_functions array. - The environment variable $_Z_NO_PROMPT_COMMAND can be set if you want + The environment variable $_Z_NO_PROMPT_COMMAND can be set if you want to handle PROMPT_COMMAND or precmd yourself. - The environment variable $_Z_EXCLUDE_DIRS can be set to an array of - directories to exclude from tracking. $HOME is always excluded. Direc‐ + The environment variable $_Z_EXCLUDE_DIRS can be set to an array of + directories to exclude from tracking. $HOME is always excluded. Direc- tories must be full paths without trailing slashes. - FILES - Data is stored in $HOME/.z. This can be overridden by setting the + Data is stored in $HOME/.z. This can be overridden by setting the $_Z_DATA environment variable. A man page (z.1) is provided. - SEE ALSO regex(7), pushd, popd, autojump, cdargs @@ -134,4 +129,4 @@ SEE ALSO -z January 2013 Z(1) +z January 2013 Z(1) diff --git a/z.1 b/z.1 index d79bec4..9752ab1 100644 --- a/z.1 +++ b/z.1 @@ -1,77 +1,94 @@ -.TH Z "1" "January 2013" "z" "User Commands" - -.SH NAME +.TH "Z" "1" "January 2013" "z" "User Commands" +.SH +NAME z \- jump around - -.SH SYNOPSIS +.SH +SYNOPSIS z [\-h] [\-l] [\-r] [\-t] [regex1 regex2 ... regexn] - -.SH AVAILABILITY +.SH +AVAILABILITY bash, zsh - -.SH DESCRIPTION +.SH +DESCRIPTION Tracks your most used directories, based on 'frecency'. .P After a short learning phase, \fBz\fR will take you to the most 'frecent' directory that matches ALL of the regexes given on the command line. - -.SH OPTIONS -\fB\-h\fR show a brief help message -.br -\fB\-l\fR list only -.br -\fB\-r\fR match by rank only -.br -\fB\-t\fR match by recent access only - +.SH +OPTIONS +.TP +\fB\-h\fR +show a brief help message +.TP +\fB\-l\fR +list only +.TP +\fB\-r\fR +match by rank only +.TP +\fB\-t\fR +match by recent access only .SH EXAMPLES -\fBz foo\fR cd to most frecent dir matching foo -.br -\fBz foo bar\fR cd to most frecent dir matching foo and bar -.br -\fBz -r foo\fR cd to highest ranked dir matching foo -.br -\fBz -t foo\fR cd to most recently accessed dir matching foo -.br -\fBz -l foo\fR list all dirs matching foo (by frecency) - -.SH NOTES - -\fBInstallation:\fR +.TP 14 +\fBz foo\fR +cd to most frecent dir matching foo +.TP 14 +\fBz foo bar\fR +cd to most frecent dir matching foo and bar +.TP 14 +\fBz -r foo\fR +cd to highest ranked dir matching foo +.TP 14 +\fBz -t foo\fR +cd to most recently accessed dir matching foo +.TP 14 +\fBz -l foo\fR +list all dirs matching foo (by frecency) +.SH +NOTES +.SS +Installation: .P Put something like this in your \fB$HOME/.bashrc\fR or \fB$HOME/.zshrc\fR: +.RS .P - \fB. /path/to/z.sh\fR +\fB. /path/to/z.sh\fR +.RE .P \fBcd\fR around for a while to build up the db. .P PROFIT!! .P Optionally: - Set \fB$_Z_CMD\fR to change the command name (default \fBz\fR). -.br - Set \fB$_Z_DATA\fR to change the datafile (default \fB$HOME/.z\fR). -.br - Set \fB$_Z_NO_RESOLVE_SYMLINKS\fR to prevent symlink resolution. -.br - Set \fB$_Z_NO_PROMPT_COMMAND\fR to handle \fBPROMPT_COMMAND/precmd\fR yourself. -.br - Set \fB$_Z_EXCLUDE_DIRS\fR to an array of directories to exclude. -.br - (These settings should go in .bashrc/.zshrc before the lines added above.) -.br - Install the provided man page \fBz.1\fR somewhere like \fB/usr/local/man/man1\fB. -.P -\fBAging:\fR -.P +.RS +Set \fB$_Z_CMD\fR to change the command name (default \fBz\fR). +.RE +.RS +Set \fB$_Z_DATA\fR to change the datafile (default \fB$HOME/.z\fR). +.RE +.RS +Set \fB$_Z_NO_RESOLVE_SYMLINKS\fR to prevent symlink resolution. +.RE +.RS +Set \fB$_Z_NO_PROMPT_COMMAND\fR to handle \fBPROMPT_COMMAND/precmd\fR yourself. +.RE +.RS +Set \fB$_Z_EXCLUDE_DIRS\fR to an array of directories to exclude. +.RE +.RS +(These settings should go in .bashrc/.zshrc before the lines added above.) +.RE +.RS +Install the provided man page \fBz.1\fR somewhere like \fB/usr/local/man/man1\fR. +.RE +.SS +Aging: The rank of directories maintained by \fBz\fR undergoes aging based on a simple formula. The rank of each entry is incremented every time it is accessed. When the sum of ranks is greater than 6000, all ranks are multiplied by 0.99. Entries with a rank lower than 1 are forgotten. -.br - -\fBFrecency:\fR -.P +.SS +Frecency: Frecency is a portmantaeu of 'recent' and 'frequency'. It is a weighted rank that depends on how often and how recently something occured. As far as I know, Mozilla came up with the term. @@ -79,20 +96,16 @@ know, Mozilla came up with the term. To \fBz\fR, a directory that has low ranking but has been accessed recently will quickly have higher rank than a directory accessed frequently a long time ago. - -Frecency is determined at runtime. -.br - -\fBCommon:\fR .P +Frecency is determined at runtime. +.SS +Common: When multiple directories match all queries, and they all have a common prefix, \fBz\fR will cd to the shortest matching directory, without regard to priority. This has been in effect, if undocumented, for quite some time, but should probably be configurable or reconsidered. -.br - -\fBTab Completion\fR -.P +.SS +Tab Completion: \fBz\fR supports tab completion. After any number of arguments, press TAB to complete on directories that match each argument. Due to limitations of the completion implementations, only the last argument will be completed in the @@ -101,9 +114,8 @@ shell. Internally, \fBz\fR decides you've requested a completion if the last argument passed is an absolute path to an existing directory. This may cause unexpected behavior if the last argument to \fBz\fR begins with \fB/\fR. -.br - -.SH ENVIRONMENT +.SH +ENVIRONMENT A function \fB_z()\fR is defined. .P The contents of the variable \fB$_Z_CMD\fR is aliased to \fB_z 2>&1\fR. If not @@ -126,14 +138,14 @@ handle \fBPROMPT_COMMAND\fR or \fBprecmd\fR yourself. The environment variable \fB$_Z_EXCLUDE_DIRS\fR can be set to an array of directories to exclude from tracking. \fB$HOME\fR is always excluded. Directories must be full paths without trailing slashes. - -.SH FILES +.SH +FILES Data is stored in \fB$HOME/.z\fR. This can be overridden by setting the \fB$_Z_DATA\fR environment variable. .P A man page (\fBz.1\fR) is provided. - -.SH SEE ALSO +.SH +SEE ALSO regex(7), pushd, popd, autojump, cdargs .P Please file bugs at https://github.com/rupa/z/