Changeset 8135737 for doc/barnowl.1

Timestamp:

Jan 23, 2012, 5:12:56 PM (13 years ago)

Author:

David Benjamin <davidben@mit.edu>

Branches:

master, release-1.10, release-1.9

Children:

9a2dd0c, ab88b05, 533b3a4

Parents:

678f607

git-author:

Kevin Riggle <kevinr@free-dissociation.com> (12/26/11 17:35:51)

git-committer:

David Benjamin <davidben@mit.edu> (01/23/12 17:12:56)

Message:

rename default config file to .owl/init.pl

motivations: to make clear that the config file is a perl script, which
runs before and is neither shadowed nor superceded by .owl/startup.

fix doc wording per andersk

more doc fixes from andersk

clean up the else-case logic, per andersk

File:

• doc/barnowl.1 (modified) (1 diff)

doc/barnowl.1

@@ -35 +35 @@
 .TP
 \fB\-c\fP, \fB\-\-config\-file\fP=\fIFILE\fP
-Specify an alternate config file for \fBBarnOwl\fP to use.  By default,
-\fBBarnOwl\fP uses \fI~/.barnowlconf\fP if it exists, and \fI~/.owlconf\fP otherwise.
+Specify an alternate config file for \fBBarnOwl\fP to use.  The config file is
+an arbitrary Perl script evaluated in the \fImain\fP package, and if it 
+overrides the \fIBarnOwl::startup\fP method that is run when \fBBarnOwl\fP 
+starts.  (Compare \fI~/.owl/startup\fP, which contains \fBBarnOwl\fP commands 
+that are run at startup after the config file is loaded.)
+
+By default, \fBBarnOwl\fP uses the first of \fI~/.owl/init.pl\fP, 
+\fI~/.barnowlconf\fP, or \fI~/.owlconf\fP that exists.
 
 .TP