update manual
This commit is contained in:
parent
9323cafb65
commit
dc530130af
GPG key ID:
3B7FBC22144E6398
3 changed files with 26 additions and 18 deletions
13
ryudo.1
13
ryudo.1
|
|
@ -1,4 +1,4 @@
|
||||||
.TH "RYUDO" "1" "September 2021" "" ""
|
.TH "RYUDO" "1" "November 2021" "" ""
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fBryudo\fR \- The floatiling window manager that flows
|
\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
|
.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\.
|
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"
|
.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
|
.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\.
|
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"
|
.SH "USAGE"
|
||||||
Right\-clicking on the desktop or an inactive window opens a menu with the following options (not all enabled by default):
|
Right\-clicking on the desktop or an inactive window opens a menu with the following options (not all enabled by default):
|
||||||
.
|
.
|
||||||
|
|
|
||||||
20
ryudo.1.html
20
ryudo.1.html
|
|
@ -56,8 +56,8 @@
|
||||||
<a href="#NAME">NAME</a>
|
<a href="#NAME">NAME</a>
|
||||||
<a href="#SYNOPSIS">SYNOPSIS</a>
|
<a href="#SYNOPSIS">SYNOPSIS</a>
|
||||||
<a href="#DESCRIPTION">DESCRIPTION</a>
|
<a href="#DESCRIPTION">DESCRIPTION</a>
|
||||||
<a href="#CONFIGURATION">CONFIGURATION</a>
|
|
||||||
<a href="#BUILDING-AND-INSTALLATION">BUILDING AND INSTALLATION</a>
|
<a href="#BUILDING-AND-INSTALLATION">BUILDING AND INSTALLATION</a>
|
||||||
|
<a href="#CONFIGURATION">CONFIGURATION</a>
|
||||||
<a href="#USAGE">USAGE</a>
|
<a href="#USAGE">USAGE</a>
|
||||||
<a href="#BUGS-AND-CAVEATS">BUGS AND CAVEATS</a>
|
<a href="#BUGS-AND-CAVEATS">BUGS AND CAVEATS</a>
|
||||||
<a href="#AUTHORS">AUTHORS</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>
|
<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>
|
<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>
|
<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>
|
<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>
|
<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>
|
<h2 id="AUTHORS">AUTHORS</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>Derek Stevens <a href="mailto:nilix@nilfm.cc" data-bare-link="true">nilix@nilfm.cc</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>Russ Cox <a href="mailto:rsc@swtch.com" data-bare-link="true">rsc@swtch.com</a></li>
|
||||||
<li>David Hogan, RIP</li>
|
<li>David Hogan, RIP</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
@ -184,7 +186,7 @@
|
||||||
|
|
||||||
<ol class='man-decor man-foot man foot'>
|
<ol class='man-decor man-foot man foot'>
|
||||||
<li class='tl'></li>
|
<li class='tl'></li>
|
||||||
<li class='tc'>September 2021</li>
|
<li class='tc'>November 2021</li>
|
||||||
<li class='tr'>ryudo(1)</li>
|
<li class='tr'>ryudo(1)</li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
|
||||||
11
ryudo.1.md
11
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.
|
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
|
## 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.
|
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
|
## USAGE
|
||||||
|
|
||||||
Right-clicking on the desktop or an inactive window opens a menu with the following options (not all enabled by default):
|
Right-clicking on the desktop or an inactive window opens a menu with the following options (not all enabled by default):
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue