mirror of
https://github.com/cheat/cheat.git
synced 2024-11-22 05:51:35 +01:00
49afd7c16b
Modify exit codes. `cheat` now returns an exit code value `2` on errors pertaining to a cheatsheet not being found. BREAKING CHANGE
222 lines
4.8 KiB
Groff
222 lines
4.8 KiB
Groff
.\" Automatically generated by Pandoc 1.17.2
|
|
.\"
|
|
.TH "CHEAT" "1" "" "" "General Commands Manual"
|
|
.hy
|
|
.SH NAME
|
|
.PP
|
|
\f[B]cheat\f[] \[em] create and view command\-line cheatsheets
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\f[B]cheat\f[] [options] [\f[I]CHEATSHEET\f[]]
|
|
.SH DESCRIPTION
|
|
.PP
|
|
\f[B]cheat\f[] allows you to create and view interactive cheatsheets on
|
|
the command\-line.
|
|
It was designed to help remind *nix system administrators of options for
|
|
commands that they use frequently, but not frequently enough to
|
|
remember.
|
|
.SH OPTIONS
|
|
.TP
|
|
.B \-\-init
|
|
Print a config file to stdout.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-c, \-\-colorize
|
|
Colorize output.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-d, \-\-directories
|
|
List cheatsheet directories.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-e, \-\-edit=\f[I]CHEATSHEET\f[]
|
|
Open \f[I]CHEATSHEET\f[] for editing.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-l, \-\-list
|
|
List available cheatsheets.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-p, \-\-path=\f[I]PATH\f[]
|
|
Filter only to sheets found on path \f[I]PATH\f[].
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-r, \-\-regex
|
|
Treat search \f[I]PHRASE\f[] as a regular expression.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-s, \-\-search=\f[I]PHRASE\f[]
|
|
Search cheatsheets for \f[I]PHRASE\f[].
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-t, \-\-tag=\f[I]TAG\f[]
|
|
Filter only to sheets tagged with \f[I]TAG\f[].
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-T, \-\-tags
|
|
List all tags in use.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-v, \-\-version
|
|
Print the version number.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \-\-rm=\f[I]CHEATSHEET\f[]
|
|
Remove (deletes) \f[I]CHEATSHEET\f[].
|
|
.RS
|
|
.RE
|
|
.SH EXAMPLES
|
|
.TP
|
|
.B To view the foo cheatsheet:
|
|
cheat \f[I]foo\f[]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To edit (or create) the foo cheatsheet:
|
|
cheat \-e \f[I]foo\f[]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To edit (or create) the foo/bar cheatsheet on the \[aq]work\[aq] cheatpath:
|
|
cheat \-p \f[I]work\f[] \-e \f[I]foo/bar\f[]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To view all cheatsheet directories:
|
|
cheat \-d
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To list all available cheatsheets:
|
|
cheat \-l
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To list all cheatsheets whose titles match \[aq]apt\[aq]:
|
|
cheat \-l \f[I]apt\f[]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To list all tags in use:
|
|
cheat \-T
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To list available cheatsheets that are tagged as \[aq]personal\[aq]:
|
|
cheat \-l \-t \f[I]personal\f[]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To search for \[aq]ssh\[aq] among all cheatsheets, and colorize matches:
|
|
cheat \-c \-s \f[I]ssh\f[]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To search (by regex) for cheatsheets that contain an IP address:
|
|
cheat \-c \-r \-s \f[I]\[aq](?:[0\-9]{1,3}.){3}[0\-9]{1,3}\[aq]\f[]
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B To remove (delete) the foo/bar cheatsheet:
|
|
cheat \-\-rm \f[I]foo/bar\f[]
|
|
.RS
|
|
.RE
|
|
.SH FILES
|
|
.SS Configuration
|
|
.PP
|
|
\f[B]cheat\f[] is configured via a YAML file that is conventionally
|
|
named \f[I]conf.yaml\f[].
|
|
\f[B]cheat\f[] will search for \f[I]conf.yaml\f[] in varying locations,
|
|
depending upon your platform:
|
|
.SS Linux, OSX, and other Unixes
|
|
.IP "1." 3
|
|
\f[B]CHEAT_CONFIG_PATH\f[]
|
|
.IP "2." 3
|
|
\f[B]XDG_CONFIG_HOME\f[]/cheat/conf.yaml
|
|
.IP "3." 3
|
|
\f[B]$HOME\f[]/.config/cheat/conf.yml
|
|
.IP "4." 3
|
|
\f[B]$HOME\f[]/.cheat/conf.yml
|
|
.SS Windows
|
|
.IP "1." 3
|
|
\f[B]CHEAT_CONFIG_PATH\f[]
|
|
.IP "2." 3
|
|
\f[B]APPDATA\f[]/cheat/conf.yml
|
|
.IP "3." 3
|
|
\f[B]PROGRAMDATA\f[]/cheat/conf.yml
|
|
.PP
|
|
\f[B]cheat\f[] will search in the order specified above.
|
|
The first \f[I]conf.yaml\f[] encountered will be respected.
|
|
.PP
|
|
If \f[B]cheat\f[] cannot locate a config file, it will ask if you\[aq]d
|
|
like to generate one automatically.
|
|
Alternatively, you may also generate a config file manually by running
|
|
\f[B]cheat \-\-init\f[] and saving its output to the appropriate
|
|
location for your platform.
|
|
.SS Cheatpaths
|
|
.PP
|
|
\f[B]cheat\f[] reads its cheatsheets from "cheatpaths", which are the
|
|
directories in which cheatsheets are stored.
|
|
Cheatpaths may be configured in \f[I]conf.yaml\f[], and viewed via
|
|
\f[B]cheat \-d\f[].
|
|
.PP
|
|
For detailed instructions on how to configure cheatpaths, please refer
|
|
to the comments in conf.yml.
|
|
.SS Autocompletion
|
|
.PP
|
|
Autocompletion scripts for \f[B]bash\f[], \f[B]zsh\f[], and
|
|
\f[B]fish\f[] are available for download:
|
|
.IP \[bu] 2
|
|
<https://github.com/cheat/cheat/blob/master/scripts/cheat.bash>
|
|
.IP \[bu] 2
|
|
<https://github.com/cheat/cheat/blob/master/scripts/cheat.fish>
|
|
.IP \[bu] 2
|
|
<https://github.com/cheat/cheat/blob/master/scripts/cheat.zsh>
|
|
.PP
|
|
The \f[B]bash\f[] and \f[B]zsh\f[] scripts provide optional integration
|
|
with \f[B]fzf\f[], if the latter is available on your \f[B]PATH\f[].
|
|
.PP
|
|
The installation process will vary per system and shell configuration,
|
|
and thus will not be discussed here.
|
|
.SH ENVIRONMENT
|
|
.TP
|
|
.B \f[B]CHEAT_CONFIG_PATH\f[]
|
|
The path at which the config file is available.
|
|
If \f[B]CHEAT_CONFIG_PATH\f[] is set, all other config paths will be
|
|
ignored.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[B]CHEAT_USE_FZF\f[]
|
|
If set, autocompletion scripts will attempt to integrate with
|
|
\f[B]fzf\f[].
|
|
.RS
|
|
.RE
|
|
.SH RETURN VALUES
|
|
.IP "0." 3
|
|
Successful termination
|
|
.IP "1." 3
|
|
Application error
|
|
.IP "2." 3
|
|
Cheatsheet(s) not found
|
|
.SH BUGS
|
|
.PP
|
|
See GitHub issues: <https://github.com/cheat/cheat/issues>
|
|
.SH AUTHOR
|
|
.PP
|
|
Christopher Allen Lane <chris@chris-allen-lane.com>
|
|
.SH SEE ALSO
|
|
.PP
|
|
\f[B]fzf(1)\f[]
|