speedie/spmenu
2
0
Fork 1
Code Issues 1 Pull requests Packages Projects Releases 15 Wiki Activity

Better documentation

Browse source
This commit is contained in:
speedie 2023-07-11 18:26:32 +02:00
parent 97ad50ce74
commit b92233e536
2 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/docs.md
View file

@ -682,7 +682,9 @@ for more information.
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
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`
Background colors: `40` through `47`
@ -745,6 +747,11 @@ avoid using a `<span>` tag, such as:
`<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
need to parse it manually. Doing so with `sed` is very easy. For example:
`... | spmenu ... | sed 's/<big>//g; s/</big>//g'`

10
spmenu.1
View file

@ -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.
Y specifies if you 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.
.PP
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]
@ -796,6 +798,14 @@ Small text (\f[V]<small>text is so small here</small>\f[R])
\f[V]<big>\f[R]
Big text (\f[V]<big>text is so big here</big>\f[R])
.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.
Therefore you need to parse it manually.
Doing so with \f[V]sed\f[R] is very easy.