aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDerek Stevens <nilix@nilfm.cc>2021-11-11 12:02:42 -0700
committerDerek Stevens <nilix@nilfm.cc>2021-11-11 12:02:42 -0700
commitdc530130af156fef1722d3ec094b71584136e8a9 (patch)
tree8c6cdbfad0f7de3a52161d445518181094641aeb
parent9323cafb65092000e44a37ac9e581823a0a70fcc (diff)
update manual
-rw-r--r--ryudo.113
-rw-r--r--ryudo.1.html20
-rw-r--r--ryudo.1.md11
3 files changed, 26 insertions, 18 deletions
diff --git a/ryudo.1 b/ryudo.1
index b10840c..b776ecc 100644
--- a/ryudo.1
+++ b/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,15 +27,18 @@ The \fB\-version\fR option prints the current version to \fBstderr\fR and then e
.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):
.
diff --git a/ryudo.1.html b/ryudo.1.html
index 120051a..3a91b8f 100644
--- a/ryudo.1.html
+++ b/ryudo.1.html
@@ -56,8 +56,8 @@
<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,16 +95,18 @@
<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>
<p>Right-clicking on the desktop or an inactive window opens a menu with the following options (not all enabled by default):</p>
@@ -171,8 +173,8 @@
<h2 id="AUTHORS">AUTHORS</h2>
<ul>
-<li>Derek Stevens <a href="&#109;&#97;&#105;&#108;&#116;&#x6f;&#58;&#x6e;&#x69;&#x6c;&#105;&#x78;&#64;&#110;&#105;&#108;&#102;&#109;&#46;&#x63;&#x63;" data-bare-link="true">&#110;&#x69;&#x6c;&#105;&#120;&#x40;&#110;&#x69;&#108;&#102;&#x6d;&#46;&#x63;&#x63;</a></li>
-<li>Russ Cox <a href="&#109;&#97;&#x69;&#x6c;&#x74;&#111;&#x3a;&#114;&#115;&#x63;&#64;&#x73;&#119;&#116;&#x63;&#x68;&#x2e;&#x63;&#111;&#109;" data-bare-link="true">&#114;&#115;&#x63;&#64;&#x73;&#x77;&#x74;&#99;&#x68;&#46;&#x63;&#x6f;&#109;</a></li>
+<li>Derek Stevens <a href="&#109;&#97;&#105;&#108;&#x74;&#111;&#x3a;&#x6e;&#x69;&#x6c;&#x69;&#120;&#64;&#x6e;&#x69;&#108;&#x66;&#109;&#x2e;&#99;&#x63;" data-bare-link="true">&#110;&#105;&#108;&#105;&#120;&#x40;&#x6e;&#x69;&#x6c;&#102;&#x6d;&#x2e;&#99;&#99;</a></li>
+<li>Russ Cox <a href="&#109;&#x61;&#x69;&#x6c;&#116;&#111;&#58;&#114;&#115;&#99;&#x40;&#115;&#x77;&#x74;&#99;&#104;&#x2e;&#99;&#111;&#x6d;" data-bare-link="true">&#114;&#x73;&#99;&#x40;&#115;&#119;&#116;&#x63;&#x68;&#46;&#x63;&#111;&#x6d;</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>
diff --git a/ryudo.1.md b/ryudo.1.md
index 2afff73..5a4efcd 100644
--- a/ryudo.1.md
+++ b/ryudo.1.md
@@ -21,16 +21,19 @@ 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
Right-clicking on the desktop or an inactive window opens a menu with the following options (not all enabled by default):