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 @@ NAME SYNOPSIS DESCRIPTION - CONFIGURATION BUILDING AND INSTALLATION + CONFIGURATION USAGE BUGS AND CAVEATS AUTHORS @@ -95,16 +95,18 @@

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):

@@ -171,8 +173,8 @@

AUTHORS

@@ -184,7 +186,7 @@
  1. -
  2. September 2021
    3. +
  3. November 2021
  4. ryudo(1)
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):