forked from speedie/spmenu
update documentation.. again
This commit is contained in:
parent
a0ee7e8fcd
commit
53112c3a97
17
docs/docs.md
17
docs/docs.md
|
@ -9,11 +9,6 @@ shell script `spmenu_run`, which handles both $PATH listing, .desktop entries
|
|||
and file listing. See spmenu_run(1) for more information related to
|
||||
using spmenu as a run launcher.
|
||||
|
||||
While spmenu is based on dmenu, and is also fully compatible with dmenu,
|
||||
spmenu introduces many new features which can be useful in shell scripting.
|
||||
|
||||
It also serves as a dmenu replacement for Wayland users.
|
||||
|
||||
## Usage
|
||||
|
||||
On runtime, spmenu reads from standard input (stdin). spmenu items are
|
||||
|
@ -544,16 +539,18 @@ One of the features that separate spmenu from dmenu is spmenu's different
|
|||
modes. As of version 0.2, there are two modes. Normal mode and Insert mode.
|
||||
These modes are of course similar to Vim.
|
||||
|
||||
Normal mode is the mode spmenu starts in unless a mode argument is specified.
|
||||
In normal mode, all keys perform some action, but you cannot type any actual
|
||||
text to filter items. This mode is used for navigation, as well
|
||||
as quickly selecting an item.
|
||||
Normal mode is the mode spmenu starts in unless a mode argument is specified
|
||||
or another mode is set in the configuration file. In normal mode, all keys
|
||||
perform some action, but you cannot type any actual text to filter items.
|
||||
This mode is used for navigation, as well as quickly selecting an item.
|
||||
|
||||
Insert mode is entered through (by default) pressing `i` in normal mode. In
|
||||
this mode, most keybinds do nothing. When you are in insert mode, you
|
||||
filter items by typing text into the field. Once you're done
|
||||
with insert mode, you can press Escape to enter normal mode again.
|
||||
|
||||
All of these keybinds can be overriden in the configuration file.
|
||||
|
||||
## -p option
|
||||
|
||||
spmenu has a -p option, which stands for prompt. It allows you to specify
|
||||
|
@ -580,7 +577,7 @@ There are also a few image related arguments, such as:
|
|||
Vector images (such as .svg) can be displayed too in the same way. This is all
|
||||
done using `imlib2` so as long as imlib2 support it, it can be used.
|
||||
|
||||
NOTE: Also note that older spmenu scripts may use the `IMG:` prefix rather than
|
||||
NOTE: Older spmenu scripts may use the `IMG:` prefix rather than
|
||||
the newer `img://` prefix. It is recommended that you use the `img://` prefix,
|
||||
but `IMG:` may be preferred if you need compatibility with older spmenu versions.
|
||||
|
||||
|
|
14
spmenu.1
14
spmenu.1
|
@ -28,12 +28,6 @@ included shell script \f[V]spmenu_run\f[R], which handles both $PATH
|
|||
listing, .desktop entries and file listing.
|
||||
See spmenu_run(1) for more information related to using spmenu as a run
|
||||
launcher.
|
||||
.PP
|
||||
While spmenu is based on dmenu, and is also fully compatible with dmenu,
|
||||
spmenu introduces many new features which can be useful in shell
|
||||
scripting.
|
||||
.PP
|
||||
It also serves as a dmenu replacement for Wayland users.
|
||||
.SS Usage
|
||||
.PP
|
||||
On runtime, spmenu reads from standard input (stdin).
|
||||
|
@ -575,7 +569,7 @@ Normal mode and Insert mode.
|
|||
These modes are of course similar to Vim.
|
||||
.PP
|
||||
Normal mode is the mode spmenu starts in unless a mode argument is
|
||||
specified.
|
||||
specified or another mode is set in the configuration file.
|
||||
In normal mode, all keys perform some action, but you cannot type any
|
||||
actual text to filter items.
|
||||
This mode is used for navigation, as well as quickly selecting an item.
|
||||
|
@ -587,6 +581,8 @@ When you are in insert mode, you filter items by typing text into the
|
|||
field.
|
||||
Once you\[cq]re done with insert mode, you can press Escape to enter
|
||||
normal mode again.
|
||||
.PP
|
||||
All of these keybinds can be overriden in the configuration file.
|
||||
.SS -p option
|
||||
.PP
|
||||
spmenu has a -p option, which stands for prompt.
|
||||
|
@ -618,8 +614,8 @@ Vector images (such as .svg) can be displayed too in the same way.
|
|||
This is all done using \f[V]imlib2\f[R] so as long as imlib2 support it,
|
||||
it can be used.
|
||||
.PP
|
||||
NOTE: Also note that older spmenu scripts may use the \f[V]IMG:\f[R]
|
||||
prefix rather than the newer \f[V]img://\f[R] prefix.
|
||||
NOTE: Older spmenu scripts may use the \f[V]IMG:\f[R] prefix rather than
|
||||
the newer \f[V]img://\f[R] prefix.
|
||||
It is recommended that you use the \f[V]img://\f[R] prefix, but
|
||||
\f[V]IMG:\f[R] may be preferred if you need compatibility with older
|
||||
spmenu versions.
|
||||
|
|
21
spmenu.html
21
spmenu.html
|
@ -176,10 +176,6 @@ option to standard output.</p>
|
|||
included shell script <code>spmenu_run</code>, which handles both $PATH
|
||||
listing, .desktop entries and file listing. See spmenu_run(1) for more
|
||||
information related to using spmenu as a run launcher.</p>
|
||||
<p>While spmenu is based on dmenu, and is also fully compatible with
|
||||
dmenu, spmenu introduces many new features which can be useful in shell
|
||||
scripting.</p>
|
||||
<p>It also serves as a dmenu replacement for Wayland users.</p>
|
||||
<h2 id="usage">Usage</h2>
|
||||
<p>On runtime, spmenu reads from standard input (stdin). spmenu items
|
||||
are separated by a newline (<code>\n</code>). When (by default) Enter is
|
||||
|
@ -872,14 +868,16 @@ behaviour you can simply set <code>ignoreglobalkeys = 1</code>.</p>
|
|||
different modes. As of version 0.2, there are two modes. Normal mode and
|
||||
Insert mode. These modes are of course similar to Vim.</p>
|
||||
<p>Normal mode is the mode spmenu starts in unless a mode argument is
|
||||
specified. In normal mode, all keys perform some action, but you cannot
|
||||
type any actual text to filter items. This mode is used for navigation,
|
||||
as well as quickly selecting an item.</p>
|
||||
specified or another mode is set in the configuration file. In normal
|
||||
mode, all keys perform some action, but you cannot type any actual text
|
||||
to filter items. This mode is used for navigation, as well as quickly
|
||||
selecting an item.</p>
|
||||
<p>Insert mode is entered through (by default) pressing <code>i</code>
|
||||
in normal mode. In this mode, most keybinds do nothing. When you are in
|
||||
insert mode, you filter items by typing text into the field. Once you’re
|
||||
done with insert mode, you can press Escape to enter normal mode
|
||||
again.</p>
|
||||
<p>All of these keybinds can be overriden in the configuration file.</p>
|
||||
<h2 id="p-option">-p option</h2>
|
||||
<p>spmenu has a -p option, which stands for prompt. It allows you to
|
||||
specify text to display next to the item list. It is displayed on the
|
||||
|
@ -903,11 +901,10 @@ item. In practice, drawing an image might look like this:</p>
|
|||
<p>Vector images (such as .svg) can be displayed too in the same way.
|
||||
This is all done using <code>imlib2</code> so as long as imlib2 support
|
||||
it, it can be used.</p>
|
||||
<p>NOTE: Also note that older spmenu scripts may use the
|
||||
<code>IMG:</code> prefix rather than the newer <code>img://</code>
|
||||
prefix. It is recommended that you use the <code>img://</code> prefix,
|
||||
but <code>IMG:</code> may be preferred if you need compatibility with
|
||||
older spmenu versions.</p>
|
||||
<p>NOTE: Older spmenu scripts may use the <code>IMG:</code> prefix
|
||||
rather than the newer <code>img://</code> prefix. It is recommended that
|
||||
you use the <code>img://</code> prefix, but <code>IMG:</code> may be
|
||||
preferred if you need compatibility with older spmenu versions.</p>
|
||||
<h2 id="colored-text">Colored text</h2>
|
||||
<p>spmenu supports colored text through SGR sequences. This is the same
|
||||
colors that you might already be using in your shell scripts. This means
|
||||
|
|
Loading…
Reference in a new issue