Skip to content

Commit

Permalink
docs: update environment variable documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
natecraddock committed Jan 21, 2023
1 parent 10579a2 commit 6a3e7eb
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
18 changes: 18 additions & 0 deletions doc/zf.1
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,24 @@ Show version information and exit
.BR \-h ", " \-\-help
Display help and exit

.SH ENV VARIABLES

.BR ZF_PROMPT
Override the default > prompt by assigning a string to this variable.
For example export ZF_PROMPT="$ ".

.BR ZF_HIGHLIGHT
Set the color used to highlight matches. Valid colors are: black, red, green, yellow, blue, magenta, cyan, white
bright_black, bright_red, bright_green, bright_yellow, bright_blue, bright_magenta, bright_cyan, and bright_white.
The default color is cyan.

.BR ZF_VI_MODE
When this variable is present and not empty ctrl+k moves up a line. When disabled ctrl+k deletes from the cursor
to the end of line.

.BR NO_COLOR
Disables colors. See https://no-color.org

.SH COMMANDS

.TP
Expand Down
8 changes: 5 additions & 3 deletions doc/zf.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,13 @@ Matching is case insensitive unless an uppercase letter is found in the query.

## ENV VARIABLES

`ZF_PROMPT` : Override the default `> ` prompt by assigning a string to this variable. For example `export ZF_PROMPT="$ "`.
`ZF_PROMPT`: Override the default `> ` prompt by assigning a string to this variable. For example `export ZF_PROMPT="$ "`.

`ZF_VI_MODE` : When this variable is present and not empty `ctrl+k` moves up a line. When disabled `ctrl+k` deletes from the cursor to the end of line
`ZF_HIGHLIGHT`: Set the color used to highlight matches. Valid colors are: black, red, green, yellow, blue, magenta, cyan, white, bright_black, bright_red, bright_green, bright_yellow, bright_blue, bright_magenta, bright_cyan, and bright_white. The default color is cyan.

`NO_COLOR` : Disables colors. See https://no-color.org
`ZF_VI_MODE`: When this variable is present and not empty `ctrl+k` moves up a line. When disabled `ctrl+k` deletes from the cursor to the end of line.

`NO_COLOR`: Disables colors. See https://no-color.org.

## COMMANDS

Expand Down

0 comments on commit 6a3e7eb

Please sign in to comment.