Mike Doherty

NAME

sysadmin-log - maintain a single-host system administration log

VERSION

version 0.009

SYNOPSIS

sysadmin-log [--date YYYY/MM/DD] [--view] [--version] [--help]

Options: --date Read from/write to a date other than today's --view View a log file instead of add to it --logdir Use a different log directory --twitter Send your log entry to Twitter --http Send your log entry to Http --http-data Sets HTTP data: - method to send using - uri to send to --no-file Skip logging to file --no-udp Skip sending log data over UDP --udp-data Sets UDP data: - whether to apply IRC colour encoding - port and host to send to --refresh-index Just refresh the index --version Print version information, then exit --help Show this manpage

DESCRIPTION

sysadmin-log allows you to maintain a single-host system administration log with simple shell commands.

OPTIONS

--date

Which date to use instead of today's date. This allows you to add entries to old logs, or view old logs. Providing a future date is a fatal error.

--view

View a log instead of adding to it.

--logdir

Sets the log directory to use - defaults to /var/log/sysadmin.

--twitter, --no-twitter

Whether to send your log entry to Twitter. Default is false.

--http, --no-http

Whether to send your log entry via HTTP. Default is false.

--http-data

Sets data related to HTTP. Specify a single key-value pair:

  • uri - the uri to send to - default is http://localhost

  • method - the method to send using - default is POST

Use it multiple times to set multiple key-value pairs:

    log --http-data uri=http://localhost --http-data method=post
--file, --no-file

Whether to log to a file. Default is true.

--udp, --no-udp

Whether to send data by UDP in addition to logging (default) or not. If true, use --udp-data to specify where to send the data.

--udp-data

Sets data related to UDP. Specify a single key-value pair:

  • irc - whether to apply IRC colour encoding or not - default is on

  • host - the host to send to - default is localhost

  • port - the port to send to - default is 9002

Use it multiple times to set multiple key-value pairs:

    log --udp-data host=localhost --udp-data port=9002
--refresh-index

Refresh the index of logs and exit.

--help, --man, -?

View this documentation.

--version

View version data.

EXAMPLES

sysadmin-log

Add something to today's log.

sysadmin-log --view --date 2011/01/01

View the log for January 1, 2011, if it exists.

sysadmin-log --no-udp

Don't send a UDP datagram while adding to today's log

sysadmin-log --refresh-index

Re-generate the index page for the logs.

sysadmin-log --udp-data host=192.168.0.3 --udp-data port=5001

Send the UDP datagram somewhere other than the default.

sysadmin-log --udp-data irc=0

Don't apply IRC colouring to the log data send via UDP.

AVAILABILITY

The project homepage is http://p3rl.org/App::Sysadmin::Log::Simple.

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit http://www.perl.com/CPAN/ to find a CPAN site near you, or see https://metacpan.org/module/App::Sysadmin::Log::Simple/.

SOURCE

The development version is on github at http://github.com/doherty/App-Sysadmin-Log-Simple and may be cloned from git://github.com/doherty/App-Sysadmin-Log-Simple.git

BUGS AND LIMITATIONS

You can make new bug reports, and view existing ones, through the web interface at https://github.com/doherty/App-Sysadmin-Log-Simple/issues.

AUTHOR

Mike Doherty <doherty@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Mike Doherty.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.