update manual
Iris Lightshard nilix@nilfm.cc
PGP Signature
-----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEkFh6dA+k/6CXFXU4O3+8IhROY5gFAmGNaNIACgkQO3+8IhRO Y5gF4g//Tq51XU2wcHJbQEyEudInBg86jisE6u3gdeKcK0gu/a6uvf4uDJW5PcE0 0XdbBE0sC9igwVzdp/KPI7BSeIKMY/GhOli5D4M/pAQX635E2NhWaULO4kylwoDp E/wU/M2Fesx1x94qr4o6aDMiuJeqwWnhpgBh/vBJuTzJffZbqQ1LEh1p7JIShV60 xejFsEtOtTXWrBAl0Hr5hTfYHuAo8Sa4qYNiXzgzVyBY4w0ZijsmecbFTb42V9v1 L9yRD62LjYwJJpTrskGdSKdoz8iEIsy8sXFNPVIu0I+9qNx3hPJY6xhEkQYqHDTZ YJd/jOGHrU0Fqqdrgzy94pemYKVJZjCuhjvOBKK45Z5sHpWiqdE2hVSGEY7HuYpi ZfHFc1QBsZMdiglsF5aczlWxZfspQ1keZ8nMHdwqDp3BC77f0aP/9SYMqJPVvimR L1TAPUXTdp1X7xH/5sBTKHmmGQGIHFc8+5ZmpUIApp9ZhlhdwpbnSsxNzU/u8XJL R0foFZ6rU9bL2zWchDm3JOT+Q+/6LrHS16RaazoPXURvplyoeGLhStHuWuJrYPm6 NikyUVXYtNH+rtOcfpkPDcjivJiB4uRhf34+bvW4UQerRGCtYardmxm0IV4HeT1Z zitqv0kz52GwSJTded3FphSasY1OtWV9Yf9Q2ybwVDJfb6bz/QM= =gth4 -----END PGP SIGNATURE-----
3 files changed,
26 insertions(+),
18 deletions(-)
M
ryudo.1
→
ryudo.1
@@ -1,4 +1,4 @@
-.TH "RYUDO" "1" "September 2021" "" "" +.TH "RYUDO" "1" "November 2021" "" "" . .SH "NAME" \fBryudo\fR \- The floatiling window manager that flows@@ -27,14 +27,17 @@ .
.P If either \fBexit\fR or \fBrestart\fR is given, the appropriate message is sent to an already\-running \fBryudo\fR instance to execute the named action\. . -.SH "CONFIGURATION" -Many configuration options have been enabled as compile\-time options configured in the \fBconfig\.h\fR configuration file\. The \fBconfig\.def\.h\fR file shipped with the source code documents all of the options and contains what I hope are sane defaults\. If \fBconfig\.h\fR does not exist in the source directory, it will be copied from \fBconfig\.def\.h\fR on build\. After changing the configuration, it is necessary to run the \fBbuild\.sh\fR and/or \fBinstall\.sh\fR script again and restart the program\. -. .SH "BUILDING AND INSTALLATION" -Run the provided \fBbuild\.sh\fR and \fBinstall\.sh\fR scripts to build and install \fBryudo\fR\. If run as root, they will install the program and manual pages to the PLAN9 installation path\. If run as a regular user, they will install the program to \fB~/bin/9/\fR and not install the manual pages\. +Run the provided \fBbuild\.sh\fR and \fBinstall\.sh\fR scripts to build and install \fBryudo\fR\. If run as root, they will install the program and manual pages to the PLAN9 installation path and install the \fBstartryudo\fR session wrapper to \fB/usr/bin/\fR and a \fB\.desktop\fR file to \fB/usr/share/xsessions/\fR If run as a regular user, they will install the program to \fB~/bin/9/\fR and not install the manual pages, wrapper, or \fB\.desktop\fR file\. . .P Building requires \fBplan9port\fR and the \fBlibX11\fR and \fBlibXT\fR headers\. Optionally, \fBlibnotify\fR is used to show notifications when switching virtual desktops\. +. +.SH "CONFIGURATION" +Many configuration options have been enabled as compile\-time options configured in the \fBconfig\.h\fR configuration file\. The \fBconfig\.def\.h\fR file shipped with the source code documents all of the options and contains what I hope are sane defaults\. If \fBconfig\.h\fR does not exist in the source directory, it will be copied from \fBconfig\.def\.h\fR on build\. After changing the configuration file, it is necessary to run the \fBbuild\.sh\fR and/or \fBinstall\.sh\fR script again and restart the program\. +. +.P +Session autostart programs can be placed in \fB~/\.ryudorc\fR, and command line arguments to \fBryudo\fR can be placed in \fB~/\.ryudo\.conf\fR \-\- these are sourced by \fBstartryudo\fR\. . .SH "USAGE" Right\-clicking on the desktop or an inactive window opens a menu with the following options (not all enabled by default):
M
ryudo.1.html
→
ryudo.1.html
@@ -56,8 +56,8 @@ <div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a> <a href="#SYNOPSIS">SYNOPSIS</a> <a href="#DESCRIPTION">DESCRIPTION</a> - <a href="#CONFIGURATION">CONFIGURATION</a> <a href="#BUILDING-AND-INSTALLATION">BUILDING AND INSTALLATION</a> + <a href="#CONFIGURATION">CONFIGURATION</a> <a href="#USAGE">USAGE</a> <a href="#BUGS-AND-CAVEATS">BUGS AND CAVEATS</a> <a href="#AUTHORS">AUTHORS</a>@@ -95,15 +95,17 @@ <p>The <code>-version</code> option prints the current version to <code>stderr</code> and then exits.</p>
<p>If either <code>exit</code> or <code>restart</code> is given, the appropriate message is sent to an already-running <code>ryudo</code> instance to execute the named action.</p> -<h2 id="CONFIGURATION">CONFIGURATION</h2> - -<p>Many configuration options have been enabled as compile-time options configured in the <code>config.h</code> configuration file. The <code>config.def.h</code> file shipped with the source code documents all of the options and contains what I hope are sane defaults. If <code>config.h</code> does not exist in the source directory, it will be copied from <code>config.def.h</code> on build. After changing the configuration, it is necessary to run the <code>build.sh</code> and/or <code>install.sh</code> script again and restart the program.</p> - <h2 id="BUILDING-AND-INSTALLATION">BUILDING AND INSTALLATION</h2> -<p>Run the provided <code>build.sh</code> and <code>install.sh</code> scripts to build and install <code>ryudo</code>. If run as root, they will install the program and manual pages to the PLAN9 installation path. If run as a regular user, they will install the program to <code>~/bin/9/</code> and not install the manual pages.</p> +<p>Run the provided <code>build.sh</code> and <code>install.sh</code> scripts to build and install <code>ryudo</code>. If run as root, they will install the program and manual pages to the PLAN9 installation path and install the <code>startryudo</code> session wrapper to <code>/usr/bin/</code> and a <code>.desktop</code> file to <code>/usr/share/xsessions/</code> If run as a regular user, they will install the program to <code>~/bin/9/</code> and not install the manual pages, wrapper, or <code>.desktop</code> file.</p> <p>Building requires <code>plan9port</code> and the <code>libX11</code> and <code>libXT</code> headers. Optionally, <code>libnotify</code> is used to show notifications when switching virtual desktops.</p> + +<h2 id="CONFIGURATION">CONFIGURATION</h2> + +<p>Many configuration options have been enabled as compile-time options configured in the <code>config.h</code> configuration file. The <code>config.def.h</code> file shipped with the source code documents all of the options and contains what I hope are sane defaults. If <code>config.h</code> does not exist in the source directory, it will be copied from <code>config.def.h</code> on build. After changing the configuration file, it is necessary to run the <code>build.sh</code> and/or <code>install.sh</code> script again and restart the program.</p> + +<p>Session autostart programs can be placed in <code>~/.ryudorc</code>, and command line arguments to <code>ryudo</code> can be placed in <code>~/.ryudo.conf</code> -- these are sourced by <code>startryudo</code>.</p> <h2 id="USAGE">USAGE</h2>@@ -171,8 +173,8 @@
<h2 id="AUTHORS">AUTHORS</h2> <ul> -<li>Derek Stevens <a href="mailto:nilix@nilfm.cc" data-bare-link="true">nilix@nilfm.cc</a></li> -<li>Russ Cox <a href="mailto:rsc@swtch.com" data-bare-link="true">rsc@swtch.com</a></li> +<li>Derek Stevens <a href="mailto:nilix@nilfm.cc" data-bare-link="true">nilix@nilfm.cc</a></li> +<li>Russ Cox <a href="mailto:rsc@swtch.com" data-bare-link="true">rsc@swtch.com</a></li> <li>David Hogan, RIP</li> </ul>@@ -184,7 +186,7 @@
<ol class='man-decor man-foot man foot'> <li class='tl'></li> - <li class='tc'>September 2021</li> + <li class='tc'>November 2021</li> <li class='tr'>ryudo(1)</li> </ol>
M
ryudo.1.md
→
ryudo.1.md
@@ -21,15 +21,18 @@ The `-version` option prints the current version to `stderr` and then exits.
If either `exit` or `restart` is given, the appropriate message is sent to an already-running `ryudo` instance to execute the named action. -## CONFIGURATION - -Many configuration options have been enabled as compile-time options configured in the `config.h` configuration file. The `config.def.h` file shipped with the source code documents all of the options and contains what I hope are sane defaults. If `config.h` does not exist in the source directory, it will be copied from `config.def.h` on build. After changing the configuration, it is necessary to run the `build.sh` and/or `install.sh` script again and restart the program. ## BUILDING AND INSTALLATION -Run the provided `build.sh` and `install.sh` scripts to build and install `ryudo`. If run as root, they will install the program and manual pages to the PLAN9 installation path. If run as a regular user, they will install the program to `~/bin/9/` and not install the manual pages. +Run the provided `build.sh` and `install.sh` scripts to build and install `ryudo`. If run as root, they will install the program and manual pages to the PLAN9 installation path and install the `startryudo` session wrapper to `/usr/bin/` and a `.desktop` file to `/usr/share/xsessions/` If run as a regular user, they will install the program to `~/bin/9/` and not install the manual pages, wrapper, or `.desktop` file. Building requires `plan9port` and the `libX11` and `libXT` headers. Optionally, `libnotify` is used to show notifications when switching virtual desktops. + +## CONFIGURATION + +Many configuration options have been enabled as compile-time options configured in the `config.h` configuration file. The `config.def.h` file shipped with the source code documents all of the options and contains what I hope are sane defaults. If `config.h` does not exist in the source directory, it will be copied from `config.def.h` on build. After changing the configuration file, it is necessary to run the `build.sh` and/or `install.sh` script again and restart the program. + +Session autostart programs can be placed in `~/.ryudorc`, and command line arguments to `ryudo` can be placed in `~/.ryudo.conf` -- these are sourced by `startryudo`. ## USAGE