From dc9e2af9f5ac117041b0383f98d9ef66bb1594b3 Mon Sep 17 00:00:00 2001 From: Derek Stevens Date: Tue, 21 Sep 2021 23:26:52 -0600 Subject: [PATCH] use config.def.h -> config.h and document it in the manpage; v1.0 --- .gitignore | 1 + build.sh | 4 ++++ config.h => config.def.h | 0 main.c | 2 +- ryudo.1 | 4 ++-- ryudo.1.html | 8 ++++---- ryudo.1.md | 2 +- 7 files changed, 13 insertions(+), 8 deletions(-) rename config.h => config.def.h (100%) diff --git a/.gitignore b/.gitignore index 5ce7d1b..cf741bc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.o ryudo +config.h diff --git a/build.sh b/build.sh index 74ceeaf..ce136f8 100755 --- a/build.sh +++ b/build.sh @@ -1,5 +1,9 @@ #!/bin/sh +if [! -e config.h ]; then + cp config.def.h config.h +fi + mk clean mk o.rio diff --git a/config.h b/config.def.h similarity index 100% rename from config.h rename to config.def.h diff --git a/main.c b/main.c index 462a1b6..7e7306e 100644 --- a/main.c +++ b/main.c @@ -21,7 +21,7 @@ #include "patchlevel.h" char* version[] = { - "ryudo version 0.6\nCopyright (c) 1994-1996 David Hogan,\n(c) 2004 Russ " + "ryudo version 1.0\nCopyright (c) 1994-1996 David Hogan,\n(c) 2004 Russ " "Cox,\n(c) 2019-2021 Derek Stevens", 0}; diff --git a/ryudo.1 b/ryudo.1 index f473c85..b10840c 100644 --- a/ryudo.1 +++ b/ryudo.1 @@ -1,4 +1,4 @@ -.TH "RYUDO" "1" "June 2021" "" "" +.TH "RYUDO" "1" "September 2021" "" "" . .SH "NAME" \fBryudo\fR \- The floatiling window manager that flows @@ -28,7 +28,7 @@ The \fB\-version\fR option prints the current version to \fBstderr\fR and then e 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 in the comments\. After changing the configuration, it is necessary to run the \fBbuild\.sh\fR and/or \fBinstall\.sh\fR script again and restart the program\. +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\. diff --git a/ryudo.1.html b/ryudo.1.html index d414e30..120051a 100644 --- a/ryudo.1.html +++ b/ryudo.1.html @@ -97,7 +97,7 @@

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 in the comments. After changing the configuration, it is necessary to run the build.sh and/or install.sh script again and restart the program.

+

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

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

AUTHORS

@@ -184,7 +184,7 @@
  1. -
  2. June 2021
    3. +
  3. September 2021
  4. ryudo(1)
diff --git a/ryudo.1.md b/ryudo.1.md index b360152..2afff73 100644 --- a/ryudo.1.md +++ b/ryudo.1.md @@ -23,7 +23,7 @@ If either `exit` or `restart` is given, the appropriate message is sent to an al ## 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 in the comments. After changing the configuration, it is necessary to run the `build.sh` and/or `install.sh` script again and restart the program. +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