r15465 - packages/trunk/excellent-bifurcation/debian

[Vincent Cheng]

Author: vcheng
Date: 2015-06-29 05:50:58 +0000 (Mon, 29 Jun 2015)
New Revision: 15465

Modified:
   packages/trunk/excellent-bifurcation/debian/changelog
   packages/trunk/excellent-bifurcation/debian/excellent-bifurcation.6
Log:
excellent-bifurcation: document config in man page


Modified: packages/trunk/excellent-bifurcation/debian/changelog
===================================================================
--- packages/trunk/excellent-bifurcation/debian/changelog	2015-06-29 05:48:57 UTC (rev 15464)
+++ packages/trunk/excellent-bifurcation/debian/changelog	2015-06-29 05:50:58 UTC (rev 15465)
@@ -2,6 +2,8 @@
 
   * Build with -std=gnu89 to force gnu89 inline semantics, fixing FTBFS with
     both clang and gcc 5. (Closes: #757406, #777846)
+  * Document configuration in man page. Thanks to Jacob for the patch!
+    (Closes: #775384)
 
  -- Vincent Cheng <vcheng at debian.org>  Sun, 28 Jun 2015 22:42:47 -0700
 

Modified: packages/trunk/excellent-bifurcation/debian/excellent-bifurcation.6
===================================================================
--- packages/trunk/excellent-bifurcation/debian/excellent-bifurcation.6	2015-06-29 05:48:57 UTC (rev 15464)
+++ packages/trunk/excellent-bifurcation/debian/excellent-bifurcation.6	2015-06-29 05:50:58 UTC (rev 15465)
@@ -2,7 +2,7 @@
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH EXCELLENT-BIFURCATION 6 "11 April 2009"
+.TH EXCELLENT-BIFURCATION 6 "January 2015"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -48,16 +48,33 @@
 charges your weapons
 .TP
 .B C
-switches between the two worlds (screens)
+switches your two forms between the two worlds (screens)
 .TP
 .B A
-turns on or off the autofire mode
+turns on or off the autofire mode (autofire is just like holding down Z)
 .TP
 .B Esc
 return to the main menu
+.PP
+Key controls can be modified inside the game options menu.
+.SH CONFIGURATION
+\fBexcellent-bifurcation\fP doesn't accept any command line arguments.
+Configuration is via the file \fB~/.config/excellent-bifurcation/init.txt\fP
+(or a different path if the environment variable \fBXDG_CONFIG_HOME\fP
+has been modified), which also records scores and configured key controls.
 
-Key controls can be modified inside the game options menu.
-.BR
+The following configuration can only be done by editing \fBinit.txt\fP
+(under the heading \fB[Misc]\fP):
+.TP
+.B Windowed
+Use \fBWindowed = 0\fP for fullscreen, \fBWindowed = 1\fP to run in a
+window (default).
+.TP
+.B vsync
+Turning vsync on (\fBvsync = 1\fP) eliminates a graphic shearing effect which
+some people might find annoying, but can slow things down on older systems.
+Default is \fBvsync = 0\fP.
+.PP
 .SH AUTHOR
 excellent-bifurcation was written by Linley Henzell.