diff --git a/README.md b/README.md index 1ab412c..45082d8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -![preview](screenshots/spmenu-themes.gif) +# spmenu -spmenu -====== +![preview](screenshots/spmenu-themes.gif) spmenu is a simple X11 and Wayland menu application which takes standard input, parses it, lets the user choose an option and sends the selected option to standard output. diff --git a/docs/docs.md b/docs/docs.md index 92e6128..a1fd8ef 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -1,5 +1,4 @@ -spmenu -====== +# spmenu spmenu is an X11 and Wayland menu application which takes standard input, parses it, lets the user choose an option and sends the selected option to standard output. @@ -855,6 +854,7 @@ or the [GitHub mirror](https://github.com/speediegq/spmenu). ## See also - spmenu_run(1) +- spmenu_test(1) - [spmenu wiki](https://spmenu.speedie.site) - [spmenu git repository](https://git.speedie.site/speedie/spmenu) - [spmenu GitHub mirror](https://github.com/speediegq/spmenu) diff --git a/docs/run-docs.md b/docs/run-docs.md index bf04395..b6470f4 100644 --- a/docs/run-docs.md +++ b/docs/run-docs.md @@ -1,5 +1,4 @@ -spmenu_run -========== +# spmenu_run spmenu includes a powerful Bash script called spmenu_run. It has several different components, but the run launcher component lists out @@ -157,6 +156,7 @@ email me. ## See also - spmenu(1) +- spmenu_test(1) - [spmenu wiki](https://spmenu.speedie.site) - [spmenu git repository](https://git.speedie.site/speedie/spmenu) - [spmenu GitHub mirror](https://github.com/speediegq/spmenu) diff --git a/docs/test-docs.md b/docs/test-docs.md new file mode 100644 index 0000000..fb704e7 --- /dev/null +++ b/docs/test-docs.md @@ -0,0 +1,33 @@ +# spmenu_test + +spmenu_test is a simple shell script which prints formatted text and colors. +It is mainly designed for spmenu development, but may also be nice for testing +colorschemes and themes. + +## Usage + +Run `spmenu_test` to run the script. It will spawn an spmenu window with +no transparency where many different colors and types of formatting can +be seen. + +spmenu_test will pass all arguments directly to spmenu, it doesn't use any +arguments for itself. See spmenu(1) for a list of arguments you can +pass to spmenu_test. If no arguments are passed, spmenu will be launched +using `--no-alpha --lines 40 --columns 1 --prompt ...`. + +## License + +spmenu is licensed under the MIT license. + +## Reporting issues + +Please report issues on the [Git repository](https://git.speedie.site/speedie/spmenu) +or the [GitHub mirror](https://github.com/speediegq/spmenu). + +## See also + +- spmenu(1) +- spmenu_run(1) +- [spmenu wiki](https://spmenu.speedie.site) +- [spmenu git repository](https://git.speedie.site/speedie/spmenu) +- [spmenu GitHub mirror](https://github.com/speediegq/spmenu) diff --git a/scripts/spmenu_make b/scripts/spmenu_make index a2315de..0f28fe7 100755 --- a/scripts/spmenu_make +++ b/scripts/spmenu_make @@ -33,15 +33,27 @@ docs() { [ ! -x "$(command -v pandoc)" ] && printf "pandoc must be installed for this action.\n" && exit 1 version="$(grep "version : '" meson.build | awk '{ print $3 }' | sed "s/'\"//g; s/\"',//g")" - printf "%% spmenu(1) ${version} | fancy dynamic menu\n" > .man.md - cat docs/docs.md >> .man.md - pandoc --standalone --to man .man.md -o spmenu.1 - rm -f .man.md - printf "%% spmenu_run(1) ${version} | \$PATH/.desktop launcher and file manager\n" > .man.md - cat docs/run-docs.md >> .man.md - pandoc --standalone --to man .man.md -o spmenu_run.1 - rm -f .man.md + if [ -f "docs/docs.md" ]; then + printf "%% spmenu(1) ${version} | fancy dynamic menu\n" > .man.md + cat docs/docs.md >> .man.md + pandoc --standalone --to man .man.md -o spmenu.1 + rm -f .man.md + fi + + if [ -f "docs/run-docs.md" ]; then + printf "%% spmenu_run(1) ${version} | \$PATH/.desktop launcher and file manager\n" > .man.md + cat docs/run-docs.md >> .man.md + pandoc --standalone --to man .man.md -o spmenu_run.1 + rm -f .man.md + fi + + if [ -f "docs/test-docs.md" ]; then + printf "%% spmenu_test(1) ${version} | spmenu test script\n" > .man.md + cat docs/test-docs.md >> .man.md + pandoc --standalone --to man .man.md -o spmenu_test.1 + rm -f .man.md + fi } kblist() { diff --git a/spmenu.1 b/spmenu.1 index 90ae202..fbd3996 100644 --- a/spmenu.1 +++ b/spmenu.1 @@ -1538,6 +1538,8 @@ mirror (https://github.com/speediegq/spmenu). .IP \[bu] 2 spmenu_run(1) .IP \[bu] 2 +spmenu_test(1) +.IP \[bu] 2 spmenu wiki (https://spmenu.speedie.site) .IP \[bu] 2 spmenu git repository (https://git.speedie.site/speedie/spmenu) diff --git a/spmenu_run.1 b/spmenu_run.1 index 19e421c..53570c8 100644 --- a/spmenu_run.1 +++ b/spmenu_run.1 @@ -198,6 +198,8 @@ email me. .IP \[bu] 2 spmenu(1) .IP \[bu] 2 +spmenu_test(1) +.IP \[bu] 2 spmenu wiki (https://spmenu.speedie.site) .IP \[bu] 2 spmenu git repository (https://git.speedie.site/speedie/spmenu) diff --git a/spmenu_test.1 b/spmenu_test.1 new file mode 100644 index 0000000..703a682 --- /dev/null +++ b/spmenu_test.1 @@ -0,0 +1,54 @@ +.\" Automatically generated by Pandoc 3.1.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "spmenu_test" "1" "" "2.2" "spmenu test script" +.hy +.SH spmenu_test +.PP +spmenu_test is a simple shell script which prints formatted text and +colors. +It is mainly designed for spmenu development, but may also be nice for +testing colorschemes and themes. +.SS Usage +.PP +Run \f[V]spmenu_test\f[R] to run the script. +It will spawn an spmenu window with no transparency where many different +colors and types of formatting can be seen. +.PP +spmenu_test will pass all arguments directly to spmenu, it doesn\[cq]t +use any arguments for itself. +See spmenu(1) for a list of arguments you can pass to spmenu_test. +If no arguments are passed, spmenu will be launched using +\f[V]--no-alpha --lines 40 --columns 1 --prompt ...\f[R]. +.SS License +.PP +spmenu is licensed under the MIT license. +.SS Reporting issues +.PP +Please report issues on the Git +repository (https://git.speedie.site/speedie/spmenu) or the GitHub +mirror (https://github.com/speediegq/spmenu). +.SS See also +.IP \[bu] 2 +spmenu(1) +.IP \[bu] 2 +spmenu_run(1) +.IP \[bu] 2 +spmenu wiki (https://spmenu.speedie.site) +.IP \[bu] 2 +spmenu git repository (https://git.speedie.site/speedie/spmenu) +.IP \[bu] 2 +spmenu GitHub mirror (https://github.com/speediegq/spmenu)