diff --git a/twander.1 b/twander.1 index 6e4480a..7e3189a 100644 --- a/twander.1 +++ b/twander.1 @@ -1,25 +1,68 @@ .TH twander 1 "TundraWare Inc." .SH twander -twander \- Short Description +Wander around a filesystem executing commands of your choice on selected +files. .SH SYNOPSIS -twander [-c filename] [-hv] +twander [-b bcolor -c filename -f fcolor -n fontname -s fontsize -w fontweight] [-hv] [startdir] .SH DESCRIPTION -Long description +\'twander\' is a GUI-based file tree navigation tool. It lets you "wander" +through your file system at will. Unlike other similar programs, +.B YOU +define what features or commands are available to manipulate selected +files. You do this via a configuration file. This gives you the +convenience of a GUI-driven file navigator with the flexibility of +defining almost any kind of command you'd like at your disposal. .SH OPTIONS .TP +.B startdir +directory in which to begin (default: ./) + +.TP +.B -b backcolor +desired background color (default: black) + +.TP .B -c path/name of configuration file specify the location and name of the configuration -file you wish to use. (default is ~/.twanderrc) +file you wish to use. (default is ~/.twander) + +.TP +.B -f forecolor +desired foreground color (default: green) .TP .B -h print this help information .TP +.B -n fontname +name of desired font family (e.g., courier, times, helvetica) (default: courier) + +.TP +.B -f fontsize +font size in points (default: 12) + +.TP .B -v print detailed version information. +.TP +.B -w fontweight +one of: bold, italic, underline, overstrike (default: none) + +.SH NOTE ON OPTIONS USE + +The color options (-b, -f) and the font specification +options (-n, -s, -w) are +.B not +checked for validity when the command line is initially read. +If you enter something unreasonable for +these options, \'twander\' will refuse to run with some +.B really +interesting and entertaining error messages. + + .SH CONFIGURATION FILE FORMAT \'twander\' @@ -29,7 +72,7 @@ and what commands are required to implement each feature. By default, the program expects to find configuration information in -.B ~/.twanderrc +.B ~/.twander but you can override this with the .B -c command line option. @@ -67,7 +110,7 @@ When you decide to run a command, \'twander\' will replace [NAME] with the currently selected file or directory name. -Here is an example .twanderrc: +Here is an example .twander file: .nf # 'twander' configuration file example @@ -95,14 +138,21 @@ shortcut defined for that command. \'twander\' will permit this, but it will warn you about it when the program starts. +If you specify an environment variable in the configuration +file which is not actually defined, \'twander\' will print +an error to that effect and refuse to run. In other words, +every environment variable referenced in your configuration +file must be defined in order for the program to run at all. +This is an intentional design choice to force the creation +of sane and meaningful configuration files. + .SH OTHER -You must also have \'python\' 2.2 or later installed. You must -also have \'anygui\' installed - see: -.B http://www.anygui.org +You must have \'python\' 2.2 or later with Tkinter support installed. .SH BUGS AND MISFEATURES -None known as of this release. +The program could be more gracious dealing with bogus font or +color specifications on the command line. .SH COPYRIGHT AND LICENSING \'twander\' is Copyright(c) 2002 TundraWare Inc. For terms of use, see