table of contents
| whereami.conf(5) | File Formats Manual | whereami.conf(5) |
NAME¶
whereami.conf — configuration file for whereami
DESCRIPTION¶
The whereami.conf file specifies what whereami does on leaving, remaining at or arriving at locations.
(Locations are detected by whereami according to specifications in the detect.conf file.)
Comments are lines starting with the `#' character. Leading whitespace is ignored on all lines, including comment lines.
Other lines are of the form:
- -location action
- The action is performed if your system was previously at this location, but is now at another location.
- =location action
- The action is performed if your system is now at this location.
- +location action
- The action is performed if your system is now at this location, but was previously at another location.
- !location action
- The action is performed if your system is not at this location.
HELPER SCRIPTS¶
In addition to the normal commands available within any shell script, whereami includes a number of helper scripts which may be useful.
- setmailrelay (none | queue [smarthost] | smarthost)
- Set the mail relay (i.e. smarthost) to "none" if you have a permanent connection, and can send e-mail directly to the recipient's mailserver.
- If you are not connected, set the relay to "queue" (optionally for a specific smarthost).
- Or send all mail to a specific smarthost, if that is what you need in this location.
- setresolver <resolv.conf stanza>
- The <resolv.conf stanza> should be something like: search localhost mydomain.com nameserver 1.2.3.4 (all on one line) to specify the domain search path and the nameserver to use.
- If you have resolvconf installed, this script will interface with that to manupulate the /etc/resolv.conf file and control DNS resolution. This is recommended.
- If you are not using resolvconf, then this will directly rewrite your /etc/resolv.conf file, inserting a section similar to the manner in which DHCP works.
- setproxy (start | stop | none | <upstream_proxy>)
- Use this script to reconfigure your local oops or squid proxy server to use a specific upstream proxy, no upstream proxy, or to stop the proxy server completely.
- The upstream proxy should be specified as "<name or ip> <port>", e.g.: setproxy 192.168.55.3 3128
- For a local squid proxy you can optionally also provide a complete set of parameters for the "cache_peer" directive (without the "cache_peer" name itself). See the squid.conf file for full details of this syntax. e.g.: setproxy 192.168.55.3 parent 3128 3140 login=user:password
- settimezone timezone
- Use this to set your timezone differently.
- masqmail_route route_name
- Use this to reconfigure masqmail to use a different masqmail routing.
SEE ALSO¶
Further documentation is available in the /usr/share/doc/whereami directory.
FILES¶
- /etc/whereami/whereami.conf
- The file we are talking about in this here manpage.
- /etc/whereami/whereiam.sh
- The script that is built based on the information in this configuration file and then executed by whereami.
LIMITATIONS¶
There should be a configuration program so that the user does not have to do any script programming.
AUTHOR¶
This manual page was written by Andrew McMillan <debian@mcmillan.net.nz> for the Debian GNU/Linux system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GPL version 2.