forked from speedie/spmenu
Better documentation
This commit is contained in:
parent
97ad50ce74
commit
b92233e536
|
@ -682,7 +682,9 @@ for more information.
|
||||||
A basic supported SGR sequence looks like this: `\033[X;YZm`
|
A basic supported SGR sequence looks like this: `\033[X;YZm`
|
||||||
|
|
||||||
Here, X specifies if you want normal or bright colors. Y specifies if you
|
Here, X specifies if you want normal or bright colors. Y specifies if you
|
||||||
want background or foreground. Z specifies the color number.
|
want background or foreground. Z specifies the color number. You can add
|
||||||
|
another separator and background color before Z to also specify a background
|
||||||
|
color.
|
||||||
|
|
||||||
Foreground colors: `30` through `37`
|
Foreground colors: `30` through `37`
|
||||||
Background colors: `40` through `47`
|
Background colors: `40` through `47`
|
||||||
|
@ -745,6 +747,11 @@ avoid using a `<span>` tag, such as:
|
||||||
`<big>`
|
`<big>`
|
||||||
: Big text (`<big>text is so big here</big>`)
|
: Big text (`<big>text is so big here</big>`)
|
||||||
|
|
||||||
|
You can also color foreground or background text using the `<span>` tag.
|
||||||
|
For example `<span foreground="#FFFF00" background="#00FFFF">text</span>`
|
||||||
|
will color the foreground and background. Of course, this is a bad way
|
||||||
|
to color text in spmenu because SGR sequences can be used instead.
|
||||||
|
|
||||||
Note that Pango markup is NOT escaped, and is piped to stdout. Therefore you
|
Note that Pango markup is NOT escaped, and is piped to stdout. Therefore you
|
||||||
need to parse it manually. Doing so with `sed` is very easy. For example:
|
need to parse it manually. Doing so with `sed` is very easy. For example:
|
||||||
`... | spmenu ... | sed 's/<big>//g; s/</big>//g'`
|
`... | spmenu ... | sed 's/<big>//g; s/</big>//g'`
|
||||||
|
|
10
spmenu.1
10
spmenu.1
|
@ -731,6 +731,8 @@ A basic supported SGR sequence looks like this: \f[V]\[rs]033[X;YZm\f[R]
|
||||||
Here, X specifies if you want normal or bright colors.
|
Here, X specifies if you want normal or bright colors.
|
||||||
Y specifies if you want background or foreground.
|
Y specifies if you want background or foreground.
|
||||||
Z specifies the color number.
|
Z specifies the color number.
|
||||||
|
You can add another separator and background color before Z to also
|
||||||
|
specify a background color.
|
||||||
.PP
|
.PP
|
||||||
Foreground colors: \f[V]30\f[R] through \f[V]37\f[R] Background colors:
|
Foreground colors: \f[V]30\f[R] through \f[V]37\f[R] Background colors:
|
||||||
\f[V]40\f[R] through \f[V]47\f[R] Reset: \f[V]0\f[R]
|
\f[V]40\f[R] through \f[V]47\f[R] Reset: \f[V]0\f[R]
|
||||||
|
@ -796,6 +798,14 @@ Small text (\f[V]<small>text is so small here</small>\f[R])
|
||||||
\f[V]<big>\f[R]
|
\f[V]<big>\f[R]
|
||||||
Big text (\f[V]<big>text is so big here</big>\f[R])
|
Big text (\f[V]<big>text is so big here</big>\f[R])
|
||||||
.PP
|
.PP
|
||||||
|
You can also color foreground or background text using the
|
||||||
|
\f[V]<span>\f[R] tag.
|
||||||
|
For example
|
||||||
|
\f[V]<span foreground=\[dq]#FFFF00\[dq] background=\[dq]#00FFFF\[dq]>text</span>\f[R]
|
||||||
|
will color the foreground and background.
|
||||||
|
Of course, this is a bad way to color text in spmenu because SGR
|
||||||
|
sequences can be used instead.
|
||||||
|
.PP
|
||||||
Note that Pango markup is NOT escaped, and is piped to stdout.
|
Note that Pango markup is NOT escaped, and is piped to stdout.
|
||||||
Therefore you need to parse it manually.
|
Therefore you need to parse it manually.
|
||||||
Doing so with \f[V]sed\f[R] is very easy.
|
Doing so with \f[V]sed\f[R] is very easy.
|
||||||
|
|
Loading…
Reference in a new issue