Habitat 2.0 Alpha User Manual
Contents
- Introduction
- Data Sources
- Displaying Data
- Customisation and Preferences
- The Collection Agent: Clockwork
- Command Line Utilities
- Data Formats
- Upload, Download and Replication
with System Garden
Manual Pages
habmeth
NAME
habmeth - Run Habitat's clockwork methods on the command line
SYNTAX
habmeth [-c <purl>] [-C <cfcmd>] [-e <fmt>] [-dDhv] <command>
DESCRIPTION
Runs a Habitat method, that would be available to jobs within the clockwork collection program.
<Command> should start with the name of the method and the remaining arguments to be applied to the methods.
With no arguments, a list of available methods are printed. Some methods do not require additional arguments other than the method name.
OPTIONS
- -c <purl>
- Append user configuration data from the route <purl>, rather than the default file ~/.habrc.
- -C <cfcmd>
- Append a list of configuration directives from <cfcmd>, separated by semicolons.
- -d
- Place ghabitat in diagnositc mode, giving an additional level of logging and sending the text to stderr rather than the default or configured destinations. In daemon mode, will send output to the controlling terminal.
- -D
- Place ghabitat in debug mode. As -d above but generating a great deal more information, designed to be used in conjunction with the source code. Also overrides normal outputs and will send the text to stderr. In daemon mode, will send output to the controlling terminal.
- -e <fmt>
- Change the logging output to one of eight preset alternative formats, some showing additional information. <fmt> must be 0-7. See LOGGING below.
- -h
- Print a help message to stdout and exit
- -v
- Print the version to stdout and exit
EXAMPLES
To find the available methods
habmeth
run a habitat method stand alone, where methods are:-
exec Direct submission to exec(2)
sh Test submit command line to sh(1)
snap Take a snapshot of a route
tstamp Timestamp in seconds since 1/1/1970 00:00:00
sample Sample tables from a timestore and produce a single table
pattern Match patterns on groups of routes to raise events
event Process event queues to carry out instructions
replicate Replicate rings to and from a repository
The tstamp method returns the time in seconds from the epoch. The example would be
habmeth tstamp
AUTHORS
Nigel Stuckey <[email protected]>
SEE ALSO
clockwork(8), killclock(8), statclock(8), habedit(8), habrep(8), habconf(5), myhabitat(1), habget(1), habput(1), habrs(1), habprobe(1)