diff options
| author | Dave Davenport <qball@gmpclient.org> | 2023-03-26 13:57:50 +0200 |
|---|---|---|
| committer | Dave Davenport <qball@gmpclient.org> | 2023-03-26 13:57:50 +0200 |
| commit | 40ecbe018e041c70268712e528f323fbed3dcea8 (patch) | |
| tree | 14ef8227f0175c9a260e2a53b64df14ae7c40891 | |
| parent | bb5868199f5dd3a42a6ce0d672d4a15887d8a7e2 (diff) | |
[Doc] Mention location of scripts in manpage.
| -rw-r--r-- | doc/rofi-script.5 | 21 | ||||
| -rw-r--r-- | doc/rofi-script.5.markdown | 10 |
2 files changed, 31 insertions, 0 deletions
diff --git a/doc/rofi-script.5 b/doc/rofi-script.5 index 2e7f22f2..f4fce94c 100644 --- a/doc/rofi-script.5 +++ b/doc/rofi-script.5 @@ -206,6 +206,27 @@ In bash the best way to do this is using \fB\fCcoproc\fR\&. If you use the \fB\fCdash\fR shell for your script, take special care with how dash handles escaped values for the separators. See issue #1201 on github. +.SH Script locations +.PP +To specify a script there are the following options: + +.RS +.IP \(bu 2 +Specify an absolute path to the script. +.IP \(bu 2 +The script is executable and located in your $PATH + +.RE + +.PP +Scripts located in the following location are loaded on startup: + +.RS +.IP \(bu 2 +The script is in \fB\fC$XDG_CONFIG_PATH/rofi/scripts/\fR, this is usually \fB\fC~/.config/rofi/scripts/\fR\&. + +.RE + .SH SEE ALSO .PP rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-theme-selector(1) diff --git a/doc/rofi-script.5.markdown b/doc/rofi-script.5.markdown index a8e663ee..e296b2d2 100644 --- a/doc/rofi-script.5.markdown +++ b/doc/rofi-script.5.markdown @@ -138,6 +138,16 @@ In bash the best way to do this is using `coproc`. If you use the `dash` shell for your script, take special care with how dash handles escaped values for the separators. See issue #1201 on github. +## Script locations + +To specify a script there are the following options: + + * Specify an absolute path to the script. + * The script is executable and located in your $PATH + +Scripts located in the following location are loaded on startup: + + * The script is in `$XDG_CONFIG_PATH/rofi/scripts/`, this is usually `~/.config/rofi/scripts/`. ## SEE ALSO |