search

baskerville / bspwm

A tiling window manager based on binary space partitioning
BSD 2-Clause "Simplified" License
7.61k stars 420 forks source link

Suggested man page tweak: "The special selector %<name>" -> "The special selector %name" #1476

Open falsifian opened 6 months ago

falsifian commented 6 months ago

Here's a suggested patch for the man page:

commit - af3bd8b4351f4478fe0fe3cfd6c09e44cb108b4b
path + /home/falsifian/co/bspwm
blob - dad47de69602369d2f683ea85b313158ff2bf606
file + doc/bspwm.1.asciidoc
--- doc/bspwm.1.asciidoc
+++ doc/bspwm.1.asciidoc
@@ -71,7 +71,7 @@ meaning.

 The following characters cannot be used in monitor or desktop names: *#*, *:*, *.*.

-The special selector *%<name>* can be used to select a monitor or a desktop with an invalid name.
+The special selector *%name* can be used to select a monitor or a desktop with an invalid name.

 Node
 ~~~~

(Sorry, it's not a pull request because I couldn't get make doc to work, and so I couldn't properly update the generated man page file(s). (I can file a separate issue if interested.))

I just spent a bunch of time trying commands like bspwm desktop '%<.>' -f and wondering why they weren't working. I think it would have helped if the man page said %name instead of %<name>. Or alternatively an example would have cleared up my confusion. emanuele6 helped me on IRC; thanks.