mirror of
				https://github.com/cheat/cheat.git
				synced 2025-11-04 07:45:28 +01:00 
			
		
		
		
	chore(dependencies): update dependencies
This commit is contained in:
		
							
								
								
									
										48
									
								
								doc/cheat.1
									
									
									
									
									
								
							
							
						
						
									
										48
									
								
								doc/cheat.1
									
									
									
									
									
								
							@@ -1,4 +1,4 @@
 | 
			
		||||
.\" Automatically generated by Pandoc 1.17.2
 | 
			
		||||
.\" Automatically generated by Pandoc 2.2.1
 | 
			
		||||
.\"
 | 
			
		||||
.TH "CHEAT" "1" "" "" "General Commands Manual"
 | 
			
		||||
.hy
 | 
			
		||||
@@ -17,62 +17,62 @@ commands that they use frequently, but not frequently enough to
 | 
			
		||||
remember.
 | 
			
		||||
.SH OPTIONS
 | 
			
		||||
.TP
 | 
			
		||||
.B \-\-init
 | 
			
		||||
.B \[en]init
 | 
			
		||||
Print a config file to stdout.
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-c, \-\-colorize
 | 
			
		||||
.B \-c, \[en]colorize
 | 
			
		||||
Colorize output.
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-d, \-\-directories
 | 
			
		||||
.B \-d, \[en]directories
 | 
			
		||||
List cheatsheet directories.
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-e, \-\-edit=\f[I]CHEATSHEET\f[]
 | 
			
		||||
.B \-e, \[en]edit=\f[I]CHEATSHEET\f[]
 | 
			
		||||
Open \f[I]CHEATSHEET\f[] for editing.
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-l, \-\-list
 | 
			
		||||
.B \-l, \[en]list
 | 
			
		||||
List available cheatsheets.
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-p, \-\-path=\f[I]PATH\f[]
 | 
			
		||||
.B \-p, \[en]path=\f[I]PATH\f[]
 | 
			
		||||
Filter only to sheets found on path \f[I]PATH\f[].
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-r, \-\-regex
 | 
			
		||||
.B \-r, \[en]regex
 | 
			
		||||
Treat search \f[I]PHRASE\f[] as a regular expression.
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-s, \-\-search=\f[I]PHRASE\f[]
 | 
			
		||||
.B \-s, \[en]search=\f[I]PHRASE\f[]
 | 
			
		||||
Search cheatsheets for \f[I]PHRASE\f[].
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-t, \-\-tag=\f[I]TAG\f[]
 | 
			
		||||
.B \-t, \[en]tag=\f[I]TAG\f[]
 | 
			
		||||
Filter only to sheets tagged with \f[I]TAG\f[].
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-T, \-\-tags
 | 
			
		||||
.B \-T, \[en]tags
 | 
			
		||||
List all tags in use.
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-v, \-\-version
 | 
			
		||||
.B \-v, \[en]version
 | 
			
		||||
Print the version number.
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B \-\-rm=\f[I]CHEATSHEET\f[]
 | 
			
		||||
.B \[en]rm=\f[I]CHEATSHEET\f[]
 | 
			
		||||
Remove (deletes) \f[I]CHEATSHEET\f[].
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
@@ -88,7 +88,7 @@ cheat \-e \f[I]foo\f[]
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B To edit (or create) the foo/bar cheatsheet on the \[aq]work\[aq] cheatpath:
 | 
			
		||||
.B To edit (or create) the foo/bar cheatsheet on the `work' cheatpath:
 | 
			
		||||
cheat \-p \f[I]work\f[] \-e \f[I]foo/bar\f[]
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
@@ -103,7 +103,7 @@ cheat \-l
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B To list all cheatsheets whose titles match \[aq]apt\[aq]:
 | 
			
		||||
.B To list all cheatsheets whose titles match `apt':
 | 
			
		||||
cheat \-l \f[I]apt\f[]
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
@@ -113,23 +113,23 @@ cheat \-T
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B To list available cheatsheets that are tagged as \[aq]personal\[aq]:
 | 
			
		||||
.B To list available cheatsheets that are tagged as `personal':
 | 
			
		||||
cheat \-l \-t \f[I]personal\f[]
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B To search for \[aq]ssh\[aq] among all cheatsheets, and colorize matches:
 | 
			
		||||
.B To search for `ssh' 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[]
 | 
			
		||||
cheat \-c \-r \-s \f[I]`(?:[0\-9]{1,3}.){3}[0\-9]{1,3}'\f[]
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.TP
 | 
			
		||||
.B To remove (delete) the foo/bar cheatsheet:
 | 
			
		||||
cheat \-\-rm \f[I]foo/bar\f[]
 | 
			
		||||
cheat \[en]rm \f[I]foo/bar\f[]
 | 
			
		||||
.RS
 | 
			
		||||
.RE
 | 
			
		||||
.SH FILES
 | 
			
		||||
@@ -159,15 +159,15 @@ depending upon your platform:
 | 
			
		||||
\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.
 | 
			
		||||
If \f[B]cheat\f[] cannot locate a config file, it will ask if you'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
 | 
			
		||||
\f[B]cheat \[en]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.
 | 
			
		||||
\f[B]cheat\f[] reads its cheatsheets from \[lq]cheatpaths\[rq], 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
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user