use config.def.h -> config.h and document it in the manpage; v1.0

This commit is contained in:
Iris Lightshard 2021-09-21 23:26:52 -06:00
parent 1ae3fe4277
commit dc9e2af9f5
Signed by: Iris Lightshard
GPG key ID: 3B7FBC22144E6398
7 changed files with 13 additions and 8 deletions

1
.gitignore vendored
View file

@ -1,2 +1,3 @@
*.o
ryudo
config.h

View file

@ -1,5 +1,9 @@
#!/bin/sh
if [! -e config.h ]; then
cp config.def.h config.h
fi
mk clean
mk o.rio

2
main.c
View file

@ -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};

View file

@ -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\.

View file

@ -97,7 +97,7 @@
<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 in the comments. 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>
<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>
@ -171,8 +171,8 @@
<h2 id="AUTHORS">AUTHORS</h2>
<ul>
<li>Derek Stevens <a href="&#x6d;&#97;&#x69;&#x6c;&#116;&#x6f;&#58;&#x6e;&#x69;&#x6c;&#105;&#120;&#x40;&#x6e;&#105;&#108;&#102;&#x6d;&#46;&#x63;&#99;" data-bare-link="true">&#110;&#105;&#x6c;&#105;&#x78;&#64;&#x6e;&#x69;&#x6c;&#102;&#109;&#x2e;&#x63;&#99;</a></li>
<li>Russ Cox <a href="&#x6d;&#x61;&#105;&#108;&#116;&#111;&#58;&#114;&#x73;&#99;&#64;&#x73;&#119;&#x74;&#x63;&#x68;&#46;&#x63;&#x6f;&#x6d;" data-bare-link="true">&#x72;&#115;&#99;&#64;&#x73;&#x77;&#x74;&#99;&#x68;&#46;&#99;&#111;&#x6d;</a></li>
<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>David Hogan, RIP</li>
</ul>
@ -184,7 +184,7 @@
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>June 2021</li>
<li class='tc'>September 2021</li>
<li class='tr'>ryudo(1)</li>
</ol>

View file

@ -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