commit fb68f5cbab8711537809d6ee635a082d0c0eb81c parent e00a19d2a42f3b94dbc13c95023a3cefd51c2a28 Author: Christoph Lohmann <20h@r-36.net> Date: Wed, 21 Oct 2015 14:28:30 +0200 Adding a Documentation section to sucks. Here GNU info and HTML documentation are added as bad examples. Diffstat:
| M | suckless.org/sucks/index.md | | | 20 | ++++++++++++++++++++ |
1 file changed, 20 insertions(+), 0 deletions(-)
diff --git a/suckless.org/sucks/index.md b/suckless.org/sucks/index.md @@ -92,6 +92,24 @@ The following programs are broken (see [rocking stuff](/rocks) for saner alterna If you still need some program which expects a floating WM, use it in floating mode. +Documentation +------------- +Somewhen GNU tried to make the world a bit more miserable by inventing +[texinfo][texinfo]. The result is that in 2015 man pages are still used and +the documentation of GNU tools requires you to run `info $application`. The +info browser is awkward and unintuitive and the reason why noone gets further +than finding 'q' to quit it. + +Look at GNU tools how to not handle documentation. + +Talking about the suck in enforced HTML documentation which forces you to open +up a 1 Gb of RAM wasting web browser just to see some eye-candy which could +have been described in the source with some easy way to jump to that line in +the source code is not worth the time. + +The suckless way is to have a short usage and a descriptive manpage. The +complete details are in the source. + See also -------- @@ -101,3 +119,5 @@ The [list of harmful software](http://harmful.cat-v.org/software/) at [cat-v.org [st]: http://st.suckless.org/ [uuterm]: http://etalabs.net/uuterm.html [icccm]: http://tronche.com/gui/x/icccm/ +[textinfo]: https://www.gnu.org/software/texinfo/ +