
                                 whereami
                                README File

                    Andrew McMillan <awm@debian.org>

This is the Debian GNU/Linux prepackaged version of the whereami package.



1.	What is "whereami"

"whereami" is a utility for laptop users or people who use their machines
in different situations all the time.

The general strategy is as follows:
  - whereami is run at boot time, when a PCMCIA card is inserted or
    removed, or at suspend/resume.
  - whereami builds a script of actions based on:
       o where you are now
       o where you were last
  - whereami executes that script.

Along with 'whereami' are a number of useful programs and scripts to help
with automating the sorts of things that many of us want to do when we
arrive (or leave) each location.

As ever, I wrote whereami for my own reasons.  It meets my needs, and I'm
only too happy to include changes to make it fit with a wider audience.



2.	What do I need?

Before using whereami, you will need to configure several items:
   - the whereami detection configuration in /etc/whereami/detect.conf
   - the whereami configuration file in /etc/whereami/whereami.conf

A number of useful scripts are also provided in the /etc/whereami/scripts
directory to assist with tasks that are regularly a part of configuration
when your computer is set up in a different environment.

A basic knowledge of shell scripting will help, but you might want to
look on this as an opportunity to learn, if you don't have experience
with shell scripts - there are plenty of examples.



3.	Configuration

You should refer to the manual, specifically detect.conf(5) whereami.conf(5),
and whereami(8) for more comprehensive information on configuration and setup.


