Commit e7bf8d31 authored by Nigel Kukard's avatar Nigel Kukard

Merge branch 'manpage' into 'master'

Manpage

See merge request !13
parents dbb118f6 d0fc53f8
Pipeline #796 passed with stages
in 52 seconds
......@@ -24,11 +24,14 @@ WriteMakefile(
NAME => 'AWITBackstepTraceback',
VERSION_FROM => "backstep-traceback",
INSTALLSCRIPT => '/usr/sbin',
INSTALLSITESCRIPT => '/usr/local/sbin',
INSTALLVENDORSCRIPT => '/usr/sbin',
EXE_FILES => [qw( backstep-traceback )],
MAN1EXT => "1",
MAN1PODS => {
'awit-ssh' => 'blib/man1/backstep-traceback.1',
'backstep-traceback' => 'blib/man1/backstep-traceback.1',
},
);
......
#!/usr/bin/perl
# backstep-traceback - Client software for the AWIT Backstep server
# Copyright (c) 2010-2016, AllWorldIT
# Copyright (c) 2010-2017, AllWorldIT
#
# 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
......@@ -25,7 +25,7 @@ backstep-traceback - Backstep Traceback is a disk snapshotting and backup utilit
=head1 SYNOPSIS
backstep-traceback xxxxx
backstep-traceback <GENERAL OPTIONS> <OPERATION MODE> ...
=cut
......@@ -57,7 +57,7 @@ use Sys::Hostname;
my $VERSION = "1.3.1";
our $VERSION = "1.3.1";
# Constants
sub LOG_DEBUG { return 5; }
......@@ -112,6 +112,212 @@ my %globalConfig = (
=head1 GENERAL OPTIONS
C<backstep-traceback> provides the below commandline options...
=head2 --help|?
Display this help information.
=head2 --version
Display version information.
=head2 --debug
Enable debugging information.
=head2 --quiet
Operate in quiet mode and only output logs if there was an warning or worse error.
=head2 --log-level=<LEVEL>
Display errors of this priority and higher: 5 = debug, 4 = info, 3 = notice 2 = warning, 1 = error
=head2 --email=<EMAIL>
Email address to send report to.
=head2 --email-subject=<SUBJECT>
Extra string to include in subject.
=head1 OPERATION MODE
Backstep Traceback runs in only one operation mode at a time...
=head2 --backup <DEST>
Do a backup to <DEST>.
=head2 --restore <SOURCE> <DEST>
Restore <SOURCE> to <DEST>. The <DEST> location is always a local path.
=head2 --use-rsync
Use rsync to backup/restore. This is default.
=head2 --use-dbackup
Use dbackup to backup/restore.
=head2 --ignore-load
Do not use nice/ionice/cputool and completely ignore load on the system.
=head1 BACKUP OPTIONS
When using --backup, the following options are available...
=head2 --lvm-snapshot=<VG/LV|VG>
Snapshot logical volume. This option takes a full LV name a/b or a VG wich which will result in all LV's being added for that
VG.
=head2 --exclude-lvm-snapshot=<VG/LV>
Exclude logical volume from snapshot.
=head2 --no-lvm-warning
Do not warn if we're not backing all the LVM volumes.
=head2 --bind-mount=<SOURCE>:<DEST>
Bind mount SOURCE to DEST NB: DEST is suffixed to the temporary mount mount.
=head2 --xattrs
Backup extended attributes.
=head2 --acls
Backup posix access control lists.
=head2 --copy-backup-filter[=<BF-FILE>]
Copy this backup filter to each mounted volume root. Default '/.backup-filter'.
=head2 --append-backup-filter
Append to any existing backup filter insted of overwriting it.
=head2 --prepend-backup-filter
Append to any existing backup filter insted of overwriting it.
=head1 ZABBIX OPTIONS
Zabbix options...
=head2 --zabbix=[XX]
Send info to Zabbix, item format is:
custom.backstep.client[XX,timestamp]
custom.backstep.client[XX,duration]
=head2 --zabbix-config=<CONFIG-FILE>
Zabbix configuration file. Default is '/etc/zabbix/zabbix_agentd.conf'.
=head1 SSH OPTIONS
SSH options are provided for below...
=head2 --port=<PORT>
SSH server port.
=head2 --pubkey=<PUBKEY>
SSH public key.
=head1 DBACKUP OPTIONS
DBackup otpions can be specified below...
=head2 -compress=<ALGO>
Compression algorithm to use for the backup.
=head1 RSYNC OPTIONS
Options for rsync can be specified using these options...
=head2 --bwlimit=<LIMIT>
Bandwidth limit. In Kbyte/s.
=head2 --deltas
Sync file changes only
=head2 --safe
Do the transfer in a safe transaction.
=head2 --verify[=<COUNT>]
Checksum verify backup. VERY SLOW!
=head2 --rsync-verbose
Make Rsync more verbose
=head1 NICE OPTIONS
Options to specify the NICE value for this process to run under are below...
=head2 --nice=<NICE>
NICE level to run process at. 20 is low, -19 is high. Default: 20.
=head1 IONICE OPTIONS
You can re-nice the IO priority below...
=head2 --io-class=<0-3>
0 is none, 1 is realtime, 2 is Best effort, 3 is idle. Default: 3.
=head2 --io-prioirty=<0-7>
0 is high, 7 is low.
=head1 CPUTOOL OPTIONS
Options can be specified to use with cputool below...
=head2 --max-load=<LOAD>
When load exceeds this amount the process will be paused. Default: 4.
=head2 --max-cpu=<CPU%>
Maximum CPU time to allocate to the process. Default: 80.
=cut
# Grab options
my %optctl = ();
GetOptions(\%optctl,
......@@ -476,7 +682,7 @@ sub displayVersion
sub displayHelp
{
print(STDERR<<EOF);
AWIT-Backstep-Traceback v$VERSION - Copyright (c) 2010-2016, AllWorldIT
AWIT-Backstep-Traceback v$VERSION - Copyright (c) 2010-2017, AllWorldIT
Usage: $0 <options>
......@@ -2749,11 +2955,11 @@ Nigel Kukard E<lt>nkukard@allworld.itE<gt>, Robert Spencer E<lt>rspencer@allworl
=head1 BUGS
All bugs should be reported via the project issue tracker
L<https://gitlab.devlabs.linuxassist.net/allworldit/awit-ssh-client/issues>.
L<https://gitlab.devlabs.linuxassist.net/awit-backstep-traceback/awit-backstep-traceback/issues>.
=head1 LICENSE AND COPYRIGHT
Copyright (C) 2016-2017, AllWorldIT
Copyright (C) 2010-2017, AllWorldIT
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
......@@ -2762,7 +2968,7 @@ the Free Software Foundation, either version 3 of the License, or
=head1 SEE ALSO
L<ssh>(1), L<rsync>(1), L<ssvncviewer>(1).
L<rsync>(1), L<cputool>(1), L<dbackup>(1), L<nice>, L<ionice>.
=cut
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment