diff options
author | Lars Wirzenius <liw@liw.fi> | 2012-06-12 18:32:52 +0100 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2012-06-12 18:32:52 +0100 |
commit | 4d26484386f9d7aebfaadfb77b50843ac2df0430 (patch) | |
tree | ada4a0edba3604e84d5f67d43c57ae81c532d39c /cliapp.5 | |
parent | 1a945fcfa2e05fdf115fa6d787f4dc373a3b3d29 (diff) | |
download | cliapp-4d26484386f9d7aebfaadfb77b50843ac2df0430.tar.gz |
Added section on boolean settings to cliapp(5)
Thanks, Neal Becker, for the inspiration.
Diffstat (limited to 'cliapp.5')
-rw-r--r-- | cliapp.5 | 26 |
1 files changed, 25 insertions, 1 deletions
@@ -1,4 +1,4 @@ -.\" Copyright (C) 2011 Lars Wirzenius +.\" Copyright (C) 2011, 2012 Lars Wirzenius .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by @@ -102,6 +102,30 @@ Example: .nf [config] pattern = foo, bar, foobar +.SS "Boolean (true/false or on/off or yes/no) settings" +When a setting can be either on or off, +it's called a Boolean setting. +Such settings are turned off by default, +and turned on if used on the command line. +In a configuration file, +they need to be set to a value: +if the value is one of +.BR yes , +.BR on , +.BR true , +or the number 1, +the setting is turned on. +Any other value means it is turned off. +.PP +.IP +.nf +[config] +verbose = true +attack-kittens = no +.fi +.PP +This turns the verbose setting on, +but does not launch attack kittens. .SS "Logging and log files" Programs using .B cliapp |