From 263eca58206fb6b0773930d961782daa1fffc049 Mon Sep 17 00:00:00 2001
From: speedie
Date: Fri, 9 Jun 2023 08:16:00 +0200
Subject: [PATCH] remove wayland support section, instead arguments in the list
are now marked with X11 only.
---
README.html | 31 ------------------------
README.md | 20 ----------------
docs/docs.md | 49 +++++++++++++-------------------------
libs/argv.c | 34 +++++++++++++--------------
spmenu.1 | 66 +++++++++++++++-------------------------------------
spmenu.html | 57 ++++++++++++++-------------------------------
6 files changed, 69 insertions(+), 188 deletions(-)
diff --git a/README.html b/README.html
index 52e9625..c7e1306 100644
--- a/README.html
+++ b/README.html
@@ -291,37 +291,6 @@ directory.
in the current directory. If you want to generate a
pacman package, run scripts/make/generate-pacman-pkg.sh
instead.
-Wayland support
-Note that Wayland support is still experimental, and some features do
-not currently work under Wayland. Some will never work under Wayland due
-to limitations. These are:
-
---x-position
and --y-position
arguments
-
-- These arguments do not work under Wayland, because the layer_shell
-protocol doesn’t allow clients to be placed on a specific position.
-
-- Embedding
-w
and window manager managed
--wm
-
-- These arguments do not make much sense on Wayland, and embedding is
-not possible due to the original implementation using XEmbed. If the
-embed argument is passed it will simply be ignored and the window will
-be layered as normal.
-
---monitor
argument
-
-- Possible under Wayland, but not really useful.
-
---vertical-padding
and
---horizontal-padding
arguments
-
-- Not possible under Wayland due to layer_shell not supporting
-it.
-
-- Window borders
-- Pasting
-
Scripts
There’s a page dedicated to user scripts over on the
diff --git a/README.md b/README.md
index d6bdd32..794275e 100644
--- a/README.md
+++ b/README.md
@@ -116,26 +116,6 @@ To generate a tarball, run `scripts/make/generate-pkg.sh` **in the current
directory**. If you want to generate a pacman package, run
`scripts/make/generate-pacman-pkg.sh` instead.
-## Wayland support
-
-Note that Wayland support is still experimental, and some features do not
-currently work under Wayland. Some will never work under Wayland due to limitations.
-These are:
-
-- `--x-position` and `--y-position` arguments
- - These arguments do not work under Wayland, because the layer_shell
- protocol doesn't allow clients to be placed on a specific position.
-- Embedding `-w` and window manager managed `-wm`
- - These arguments do not make much sense on Wayland, and embedding is not possible
- due to the original implementation using XEmbed. If the embed argument is passed
- it will simply be ignored and the window will be layered as normal.
-- `--monitor` argument
- - Possible under Wayland, but not really useful.
-- `--vertical-padding` and `--horizontal-padding` arguments
- - Not possible under Wayland due to layer_shell not supporting it.
-- Window borders
-- Pasting
-
## Scripts
There's a page dedicated to user scripts
diff --git a/docs/docs.md b/docs/docs.md
index bbb0eff..2a43416 100644
--- a/docs/docs.md
+++ b/docs/docs.md
@@ -33,7 +33,7 @@ You may use long, descriptive arguments or the shorter arguments.
: Set spmenu line height to height
`-mw, --min-width width`
-: Set minimum width to width
+: Set minimum width to width when centered
`-g, --columns grid`
: Set the number of grids to grid
@@ -126,10 +126,10 @@ You may use long, descriptive arguments or the shorter arguments.
: Don't allow typing, the user must select an option
`-x, --x-position x offset`
-: Offset spmenu x position by x offset
+: Offset spmenu x position by x offset (X11 only)
`-y, --y-position y offset`
-: Offset spmenu y position by y offset
+: Offset spmenu y position by y offset (X11 only)
`-n, --preselect line`
: Preselect line line in the list of items
@@ -150,7 +150,7 @@ You may use long, descriptive arguments or the shorter arguments.
: Set caps lock off text to text
`-bw, --border-width width`
-: Set width of the border to width . 0 will disable the border
+: Set width of the border to width. 0 will disable the border (X11 only)
`-so, --sort`
: Sort matches
@@ -255,22 +255,22 @@ You may use long, descriptive arguments or the shorter arguments.
: Show caps lock indicator
`-xrdb, --xrdb`
-: Load .Xresources on runtime
+: Load .Xresources on runtime (X11 only)
`-nxrdb, --no-xrdb`
-: Don't load .Xresources on runtime
+: Don't load .Xresources on runtime (X11 only)
`-gbc, --global-colors`
-: Recognize global colors (such as *.color1) on runtime
+: Recognize global colors (such as \*.color1) on runtime (X11 only)
`-ngbc, --no-global-colors`
-: Don't recognize global colors (such as *.color1) on runtime
+: Don't recognize global colors (such as \*.color1) on runtime (X11 only)
`-m, --monitor monitor`
-: Specify a monitor to run spmenu on
+: Specify a monitor to run spmenu on (X11 only)
`-w, --embed window id`
-: Embed spmenu inside window id
+: Embed spmenu inside window id (X11 only)
`-H, --hist-file hist file`
: Specify a file to save the history to
@@ -285,16 +285,16 @@ You may use long, descriptive arguments or the shorter arguments.
: Set text padding to padding
`-vem, --vertical-margin margin`
-: Set the vertical margin
+: Set the vertical margin to margin
`-hom, --horizontal-margin margin`
-: Set the horizontal margin
+: Set the horizontal margin to margin
`-lp, --vertical-padding padding`
-: Set the vertical padding
+: Set the vertical padding to padding
`-hp, --horizontal-padding padding`
-: Set the horizontal padding
+: Set the horizontal padding to padding
`-la, --left-arrow-symbol symbol`
: Set the left arrow to symbol
@@ -318,10 +318,10 @@ You may use long, descriptive arguments or the shorter arguments.
: Position the image in the top center
`-wm, --managed, --x11-client`
-: Spawn spmenu as a window manager controlled client/window. Useful for testing
+: Spawn spmenu as a window manager controlled client/window (X11 only)
`-nwm, --unmanaged`
-: Don't spawn spmenu as a window manager controlled client/window. Useful for testing
+: Don't spawn spmenu as a window manager controlled client/window (X11 only)
`-cf, --config-file file`
: Set config file to load to file
@@ -824,23 +824,6 @@ run `printf 'spmenu:version' | spmenu`. There are a few of these.
`spmenu:license`
: Print the spmenu license
-## Wayland support
-
-Note that Wayland support is still experimental, and some features do not
-currently work under Wayland. Some will never work under Wayland due to limitations.
-These are:
-
-- `--x-position` and `--y-position` arguments
- - These arguments do not work under Wayland, because the layer_shell
- protocol doesn't allow clients to be placed on a specific position.
-- Embedding `-w` and window manager managed `-wm`
- - These arguments do not make much sense on Wayland, and embedding is not possible
- due to the original implementation using XEmbed. If the embed argument is passed
- it will simply be ignored and the window will be layered as normal.
-- `--monitor` argument
-- Window borders
-- Pasting
-
## License
spmenu is licensed under the MIT license because that's the original suckless
diff --git a/libs/argv.c b/libs/argv.c
index c41004e..dc254a6 100644
--- a/libs/argv.c
+++ b/libs/argv.c
@@ -529,7 +529,7 @@ void usage(int status) {
"- Arguments -\n"
"spmenu -l, --lines Set line count to stdin\n"
"spmenu -mh, --line-height Set spmenu line height to \n"
- "spmenu -mw, --min-width Set minimum width to \n"
+ "spmenu -mw, --min-width Set minimum width to when centered\n"
"spmenu -g, --columns Set the number of grids to \n"
"spmenu -gc, --generate-cache Generate image cache\n"
"spmenu -ngc, --no-generate-cache Don't generate image cache\n"
@@ -562,15 +562,15 @@ void usage(int status) {
"spmenu -nt, --no-allow-typing Don't allow typing, the user must select an option\n"
, status ? stderr : stdout);
- fputs("spmenu -x, --x-position Offset spmenu x position by \n"
- "spmenu -y, --y-position Offset spmenu y position by \n"
+ fputs("spmenu -x, --x-position Offset spmenu x position by (X11 only)\n"
+ "spmenu -y, --y-position Offset spmenu y position by (X11 only)\n"
"spmenu -n, --preselect Preselect in the list of items\n"
"spmenu -z, --width Width of the spmenu window\n"
"spmenu -nmt, --normal-mode-text Set normal mode text to \n"
"spmenu -imt, --insert-mode-text Set insert mode text to \n"
"spmenu -clon, --caps-lock-on-text Set caps lock on text to \n"
"spmenu -clof, --caps-lock-off-text Set caps lock off text to \n"
- "spmenu -bw, --border-width Set width of the border to . 0 will disable the border\n"
+ "spmenu -bw, --border-width Set width of the border to . 0 will disable the border (X11 only)\n"
"spmenu -so, --sort Sort matches\n"
"spmenu -nso, --no-sort Don't sort matches\n"
"spmenu -pri, --priority Specify a list of items that take priority\n"
@@ -608,23 +608,23 @@ void usage(int status) {
"spmenu -shl, --show-highlighting Show highlight\n"
"spmenu -si, --show-image Show image\n"
"spmenu -scl, --show-caps Show caps lock indicator\n"
- "spmenu -xrdb, --xrdb Load .Xresources on runtime\n"
- "spmenu -nxrdb, --no-xrdb Don't load .Xresources on runtime\n"
- "spmenu -gbc, --global-colors Recognize global colors (such as *.color1) on runtime\n"
- "spmenu -ngbc, --no-global-colors Don't recognize global colors (such as *.color1) on runtime\n"
- "spmenu -m, --monitor Specify a monitor to run spmenu on\n"
- "spmenu -w, --embed Embed spmenu inside \n"
+ "spmenu -xrdb, --xrdb Load .Xresources on runtime (X11 only)\n"
+ "spmenu -nxrdb, --no-xrdb Don't load .Xresources on runtime (X11 only)\n"
+ "spmenu -gbc, --global-colors Recognize global colors (such as *.color1) on runtime (X11 only)\n"
+ "spmenu -ngbc, --no-global-colors Don't recognize global colors (such as *.color1) on runtime (X11 only)\n"
+ "spmenu -m, --monitor Specify a monitor to run spmenu on (X11 only)\n"
+ "spmenu -w, --embed Embed spmenu inside (X11 only)\n"
"spmenu -H, --hist-file Specify a file to save the history to\n"
"spmenu -lf, --list-file Specify a file to load entries from\n"
"spmenu -ig, --image-gaps Set image gaps to \n"
"spmenu -txp, --text-padding Set text padding to \n"
- "spmenu -lp, --vertical-padding Set the vertical padding\n"
- "spmenu -hp, --horizontal-padding Set the horizontal padding\n"
- "spmenu -vem, --vertical-margin Set the vertical margin\n"
- "spmenu -hom, --horizontal-margin Set the horizontal margin\n"
+ "spmenu -lp, --vertical-padding Set the vertical padding to \n"
+ "spmenu -hp, --horizontal-padding Set the horizontal padding to \n"
+ "spmenu -vem, --vertical-margin Set the vertical margin to \n"
+ "spmenu -hom, --horizontal-margin Set the horizontal margin to \n"
"spmenu -la, --left-arrow-symbol Set the left arrow to \n"
"spmenu -ra, --right-arrow-symbol Set the right arrow to \n"
- "spmenu -is, --image-size Image size\n"
+ "spmenu -is, --image-size Set image size to \n"
"spmenu -it, --image-top Position the image at the top\n"
"spmenu -ib, --image-bottom Position the image at the bottom\n"
"spmenu -ic, --image-center Position the image in the center\n"
@@ -632,8 +632,8 @@ void usage(int status) {
, status ? stderr : stdout);
// general/config related
- fputs("spmenu -wm, --managed, --x11-client Spawn spmenu as a window manager controlled client/window. Useful for testing\n"
- "spmenu -nwm, --unmanaged Don't spawn spmenu as a window manager controlled client/window. Useful for testing\n"
+ fputs("spmenu -wm, --managed, --x11-client Spawn spmenu as a window manager controlled client/window (X11 only)\n"
+ "spmenu -nwm, --unmanaged Don't spawn spmenu as a window manager controlled client/window (X11 only)\n"
"spmenu -cf, --config-file Set config file to load to \n"
"spmenu -lcfg, --load-config Load spmenu configuration (~/.config/spmenu/spmenu.conf)\n"
"spmenu -ncfg, --no-load-config Don't load spmenu configuration (~/.config/spmenu/spmenu.conf)\n"
diff --git a/spmenu.1 b/spmenu.1
index 9fd0d83..c49b926 100644
--- a/spmenu.1
+++ b/spmenu.1
@@ -55,7 +55,7 @@ You may use long, descriptive arguments or the shorter arguments.
Set spmenu line height to height
.TP
\f[V]-mw, --min-width width\f[R]
-Set minimum width to width
+Set minimum width to width when centered
.TP
\f[V]-g, --columns grid\f[R]
Set the number of grids to grid
@@ -148,10 +148,10 @@ Allow the user to type
Don\[cq]t allow typing, the user must select an option
.TP
\f[V]-x, --x-position x offset\f[R]
-Offset spmenu x position by x offset
+Offset spmenu x position by x offset (X11 only)
.TP
\f[V]-y, --y-position y offset\f[R]
-Offset spmenu y position by y offset
+Offset spmenu y position by y offset (X11 only)
.TP
\f[V]-n, --preselect line\f[R]
Preselect line line in the list of items
@@ -172,8 +172,8 @@ Set caps lock on text to text
Set caps lock off text to text
.TP
\f[V]-bw, --border-width width\f[R]
-Set width of the border to width .
-0 will disable the border
+Set width of the border to width.
+0 will disable the border (X11 only)
.TP
\f[V]-so, --sort\f[R]
Sort matches
@@ -278,22 +278,23 @@ Show image
Show caps lock indicator
.TP
\f[V]-xrdb, --xrdb\f[R]
-Load .Xresources on runtime
+Load .Xresources on runtime (X11 only)
.TP
\f[V]-nxrdb, --no-xrdb\f[R]
-Don\[cq]t load .Xresources on runtime
+Don\[cq]t load .Xresources on runtime (X11 only)
.TP
\f[V]-gbc, --global-colors\f[R]
-Recognize global colors (such as *.color1) on runtime
+Recognize global colors (such as *.color1) on runtime (X11 only)
.TP
\f[V]-ngbc, --no-global-colors\f[R]
-Don\[cq]t recognize global colors (such as *.color1) on runtime
+Don\[cq]t recognize global colors (such as *.color1) on runtime (X11
+only)
.TP
\f[V]-m, --monitor monitor\f[R]
-Specify a monitor to run spmenu on
+Specify a monitor to run spmenu on (X11 only)
.TP
\f[V]-w, --embed window id\f[R]
-Embed spmenu inside window id
+Embed spmenu inside window id (X11 only)
.TP
\f[V]-H, --hist-file hist file\f[R]
Specify a file to save the history to
@@ -308,16 +309,16 @@ Set image gaps to gaps
Set text padding to padding
.TP
\f[V]-vem, --vertical-margin margin\f[R]
-Set the vertical margin
+Set the vertical margin to margin
.TP
\f[V]-hom, --horizontal-margin margin\f[R]
-Set the horizontal margin
+Set the horizontal margin to margin
.TP
\f[V]-lp, --vertical-padding padding\f[R]
-Set the vertical padding
+Set the vertical padding to padding
.TP
\f[V]-hp, --horizontal-padding padding\f[R]
-Set the horizontal padding
+Set the horizontal padding to padding
.TP
\f[V]-la, --left-arrow-symbol symbol\f[R]
Set the left arrow to symbol
@@ -341,12 +342,11 @@ Position the image in the center
Position the image in the top center
.TP
\f[V]-wm, --managed, --x11-client\f[R]
-Spawn spmenu as a window manager controlled client/window.
-Useful for testing
+Spawn spmenu as a window manager controlled client/window (X11 only)
.TP
\f[V]-nwm, --unmanaged\f[R]
-Don\[cq]t spawn spmenu as a window manager controlled client/window.
-Useful for testing
+Don\[cq]t spawn spmenu as a window manager controlled client/window (X11
+only)
.TP
\f[V]-cf, --config-file file\f[R]
Set config file to load to file
@@ -1525,34 +1525,6 @@ Print the spmenu version
.TP
\f[V]spmenu:license\f[R]
Print the spmenu license
-.SS Wayland support
-.PP
-Note that Wayland support is still experimental, and some features do
-not currently work under Wayland.
-Some will never work under Wayland due to limitations.
-These are:
-.IP \[bu] 2
-\f[V]--x-position\f[R] and \f[V]--y-position\f[R] arguments
-.RS 2
-.IP \[bu] 2
-These arguments do not work under Wayland, because the layer_shell
-protocol doesn\[cq]t allow clients to be placed on a specific position.
-.RE
-.IP \[bu] 2
-Embedding \f[V]-w\f[R] and window manager managed \f[V]-wm\f[R]
-.RS 2
-.IP \[bu] 2
-These arguments do not make much sense on Wayland, and embedding is not
-possible due to the original implementation using XEmbed.
-If the embed argument is passed it will simply be ignored and the window
-will be layered as normal.
-.RE
-.IP \[bu] 2
-\f[V]--monitor\f[R] argument
-.IP \[bu] 2
-Window borders
-.IP \[bu] 2
-Pasting
.SS License
.PP
spmenu is licensed under the MIT license because that\[cq]s the original
diff --git a/spmenu.html b/spmenu.html
index f58825b..84128d5 100644
--- a/spmenu.html
+++ b/spmenu.html
@@ -197,7 +197,7 @@ Set spmenu line height to height
-mw, --min-width width
-Set minimum width to width
+Set minimum width to width when centered
-g, --columns grid
@@ -321,11 +321,11 @@ Don’t allow typing, the user must select an option
-x, --x-position x offset
-Offset spmenu x position by x offset
+Offset spmenu x position by x offset (X11 only)
-y, --y-position y offset
-Offset spmenu y position by y offset
+Offset spmenu y position by y offset (X11 only)
-n, --preselect line
@@ -353,7 +353,7 @@ Set caps lock off text to text
-bw, --border-width width
-Set width of the border to width . 0 will disable the border
+Set width of the border to width. 0 will disable the border (X11 only)
-so, --sort
@@ -493,27 +493,27 @@ Show caps lock indicator
-xrdb, --xrdb
-Load .Xresources on runtime
+Load .Xresources on runtime (X11 only)
-nxrdb, --no-xrdb
-Don’t load .Xresources on runtime
+Don’t load .Xresources on runtime (X11 only)
-gbc, --global-colors
-Recognize global colors (such as *.color1) on runtime
+Recognize global colors (such as *.color1) on runtime (X11 only)
-ngbc, --no-global-colors
-Don’t recognize global colors (such as *.color1) on runtime
+Don’t recognize global colors (such as *.color1) on runtime (X11 only)
-m, --monitor monitor
-Specify a monitor to run spmenu on
+Specify a monitor to run spmenu on (X11 only)
-w, --embed window id
-Embed spmenu inside window id
+Embed spmenu inside window id (X11 only)
-H, --hist-file hist file
@@ -533,19 +533,19 @@ Set text padding to padding
-vem, --vertical-margin margin
-Set the vertical margin
+Set the vertical margin to margin
-hom, --horizontal-margin margin
-Set the horizontal margin
+Set the horizontal margin to margin
-lp, --vertical-padding padding
-Set the vertical padding
+Set the vertical padding to padding
-hp, --horizontal-padding padding
-Set the horizontal padding
+Set the horizontal padding to padding
-la, --left-arrow-symbol symbol
@@ -577,13 +577,12 @@ Position the image in the top center
-wm, --managed, --x11-client
-Spawn spmenu as a window manager controlled client/window. Useful for
-testing
+Spawn spmenu as a window manager controlled client/window (X11 only)
-nwm, --unmanaged
-Don’t spawn spmenu as a window manager controlled client/window. Useful
-for testing
+Don’t spawn spmenu as a window manager controlled client/window (X11
+only)
-cf, --config-file file
@@ -1537,28 +1536,6 @@ Print the spmenu version
Print the spmenu license
-Wayland support
-Note that Wayland support is still experimental, and some features do
-not currently work under Wayland. Some will never work under Wayland due
-to limitations. These are:
-
---x-position
and --y-position
arguments
-
-- These arguments do not work under Wayland, because the layer_shell
-protocol doesn’t allow clients to be placed on a specific position.
-
-- Embedding
-w
and window manager managed
--wm
-
-- These arguments do not make much sense on Wayland, and embedding is
-not possible due to the original implementation using XEmbed. If the
-embed argument is passed it will simply be ignored and the window will
-be layered as normal.
-
---monitor
argument
-- Window borders
-- Pasting
-
License
spmenu is licensed under the MIT license because that’s the original
suckless license. See the included LICENSE file for more