X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fyoink;a=blobdiff_plain;f=doc%2Fyoink.6.in;h=c5eec633ed774b9fce72558e549db4137670ff1b;hp=5425c3a91f23021168972ed7120e6e1b591fcfa3;hb=87bc17e55b0c1dc73ecc66df856d3f08fd7a7724;hpb=838bc00015eb7f583c7cf4b3b1007697bf047da1 diff --git a/doc/yoink.6.in b/doc/yoink.6.in index 5425c3a..c5eec63 100644 --- a/doc/yoink.6.in +++ b/doc/yoink.6.in @@ -85,11 +85,12 @@ looks for configuration files and loads them in this order, with the options in prior configuration files taking precedence over the same options if they exist in multiple configuration files: .TP -1. $YOINK_CONFIGFILE -This is an optional environment variable. +1. $YOINKRC +This is an optional environment variable you can set to point to a configuration +file. .TP 2. $HOME/.yoinkrc -This is a specific user's configuration file. +This is a specific user's personal configuration file. .TP 3. /etc/yoinkrc This is the system-wide configuration file. @@ -213,29 +214,33 @@ responds to some variables in the environment: HOME If set to a path of a valid directory (presumably a user's home directory), .B yoink -will load options from the configuration file at $HOME/.yoinkrc, if it exists. -Saving options within the game will cause this file to be over-written with the -new options. +will look for a file at +.I $HOME/.yoinkrc +and load it as a configuration file. Saving options within the game will cause +this file to be over-written with the new options, unless the +.I YOINKRC +variable is set. .TP USER .B yoink uses this variable to guess the user's nickname, for a high score entry or whatever. .TP -YOINK_CONFIGFILE -If set to a path of a valid configuration file, -.B yoink -will load the options from that file, and those options will take precedence -over options loaded from other configuration files. Any in-game saving will -cause this file to be over-written by the new options rather than the file at -$HOME/.yoinkrc. -.TP YOINK_DATADIR If set to a path of a valid directory, .B yoink will look in this directory first when it is loading game assets. Set this -variable if you move the game's assets to another directory or want to load your -own assets. +variable if you move the game's assets to another directory or perhaps want to +load your own custom assets rather than the defaults. +.TP +YOINKRC +If set to a path of a valid configuration file, +.B yoink +will load the options from that file, and those options will take precedence +over options loaded from other configuration files. Any in-game saving will +cause this file to be over-written by the new options rather than the +.I $HOME/.yoinkrc +config file. .br .SH NOTES .PP