summain(1) [debian man page]
SUMMAIN(1) General Commands Manual SUMMAIN(1) NAME
summain - gather file checksums and metadata SYNOPSIS
summain [-c=CHECKSUM] [--checksum=CHECKSUM] [--config=FILE] [--dump-config] [--dump-memory-profile=METHOD] [--dump-setting-names] [--exclude=FIELD] [--generate-manpage=TEMPLATE] [-h] [--help] [--list-config-files] [--log=FILE] [--log-keep=N] [--log-level=LEVEL] [--log-max=SIZE] [--log-mode=MODE] [-m] [--mangle-paths] [--no-default-configs] [--output=FILE] [-f=OUTPUT-FORMAT] [--output-format=OUTPUT-FORMAT] [-r] [--relative-paths] [--secret=SECRET] [--version] [FILE]... DESCRIPTION
summain gathers metadata about files, and computes their checksums. It is intended to create a manifest of the files. The manifest can be used to see if something has changed: a new manifest can be created and compared with the old one with diff(1). The manifest looks like this: Name: foo/bar/foobar SHA1: 1234123413241324 Mtime: 2010-01-01 02:08:00.127651 +0000 Mode: 1755 The filename is URL-encoded to ensure it is purely ASCII. Mode is in octal. Only some inode fields are included. It does not make sense to compare, for example, the access time, so that is not included. Time stamps are given using microsecond precision, for the benefit of those filesystems that can support precise timestamps. (Should be nanosecond, but Python return timestamps as floating point, and nanosecond precision is too much for the floating point type.) The inode and device number fields will not be reported accurately. Instead, they are normalized so that manifests are useful after the files have been restored from backups. Accurate numbers would mean everything seems to have changed. Normalized means that there will be no differences. The numbers are reported so that hard links can be checked. Directories named on the command line will be recursed automatically. OPTIONS
-c, --checksum=CHECKSUM which checksums to compute: MD5, SHA1, SHA224, SHA256, SHA384, SHA512; use once per checksum type (default is SHA1) --config=FILE add FILE to config files --dump-config write out the entire current configuration --dump-memory-profile=METHOD make memory profiling dumps using METHOD, which is one of: none, simple, meliae, or heapy (default: simple) --dump-setting-names write out all names of settings and quit --exclude=FIELD do not output or compute FIELD --generate-manpage=TEMPLATE fill in manual page TEMPLATE -h, --help show this help message and exit --list-config-files list all possible config files --log=FILE write log entries to FILE (default is to not write log files at all); use "syslog" to log to system log, or "none" to disable log- ging --log-keep=N keep last N logs (10) --log-level=LEVEL log at LEVEL, one of debug, info, warning, error, critical, fatal (default: debug) --log-max=SIZE rotate logs larger than SIZE, zero for never (default: 0) --log-mode=MODE set permissions of new log files to MODE (octal; default 0600) -m, --mangle-paths mangle (obfuscate) paths --no-default-configs clear list of configuration files to read --output=FILE write output to FILE, instead of standard output -f, --output-format=OUTPUT-FORMAT choose output format (rfc822, csv, json) -r, --relative-paths print paths relative to arguments --secret=SECRET use SECRET to make mangled paths unguessable --version show program's version number and exit SUMMAIN(1)
Check Out this Related Man Page
OBNAM-BENCHMARK(1) General Commands Manual OBNAM-BENCHMARK(1) NAME
obnam-benchmark - benchmark obnam SYNOPSIS
obnam-benchmark [--config=FILE] [--description=DESCRIPTION] [--drop-caches] [--dump-config] [--dump-memory-profile=METHOD] [--dump-setting-names] [--file-size=SIZE] [--generate-manpage=TEMPLATE] [--generations=N] [-h] [--help] [--larch-branch=DIR] [--list-config-files] [--log=FILE] [--log-keep=N] [--log-level=LEVEL] [--log-max=SIZE] [--log-mode=MODE] [--no-default-configs] [--obnam-branch=DIR] [--output=FILE] [--profile-name=PROFILE-NAME] [--results=DIR] [--seivot-branch=DIR] [--seivot-log=SEIVOT-LOG] [--sftp-delay=SFTP-DELAY] [--size=PAIR] [--use-sftp-repository] [--use-sftp-root] [--verify] [--version] [--with-encryption] [FILE]... DESCRIPTION
obnam-benchmark benchmarks the obnam(1) backup application, by measuring how much time it takes to do a backup, restore, etc, in various scenarios. obnam-benchmark uses the seivot(1) tool for actually running the benchmarks, but makes some helpful assumptions about things, to make it simpler to run than running seivot directly. Benchmarks are run using two different usage profiles: mailspool (all files are small), and mediaserver (all files are big). For each pro- file, test data of the desired total size is generated, backed up, and then several incremental generations are backed up, each adding some more generated test data. Then other operations are run against the backup repository: restoring, listing the contents of, and removing each generation. The result of the benchmark is a .seivot file per profile, plus a Python profiler file for each run of obnam. These are stored in ../benchmarks. A set of .seivot files can be summarized for comparison with seivots-summary(1). The profiling files can be viewed with the usual Python tools: see the pstats module. The benchmarks are run against a version of obnam checked out from version control. It is not (currently) possible to run the benchmark against an installed version of obnam. Also the larch Python library, which obnam needs, needs to be checked out from version control. The --obnam-branch and --larch-branch options set the locations, if the defaults are not correct. OPTIONS
--config=FILE add FILE to config files --description=DESCRIPTION describe benchmark --drop-caches drop kernel buffer caches --dump-config write out the entire current configuration --dump-memory-profile=METHOD make memory profiling dumps using METHOD, which is one of: none, simple, meliae, or heapy (default: simple) --dump-setting-names write out all names of settings and quit --file-size=SIZE how big should files be? --generate-manpage=TEMPLATE fill in manual page TEMPLATE --generations=N benchmark N generations (default: 5) -h, --help show this help message and exit --larch-branch=DIR use DIR as the larch branch (default: /sbuild-nonexistent/larch/trunk) --list-config-files list all possible config files --log=FILE write log entries to FILE (default is to not write log files at all); use "syslog" to log to system log, or "none" to disable log- ging --log-keep=N keep last N logs (10) --log-level=LEVEL log at LEVEL, one of debug, info, warning, error, critical, fatal (default: debug) --log-max=SIZE rotate logs larger than SIZE, zero for never (default: 0) --log-mode=MODE set permissions of new log files to MODE (octal; default 0600) --no-default-configs clear list of configuration files to read --obnam-branch=DIR use DIR as the obnam branch to benchmark (default: .) --output=FILE write output to FILE, instead of standard output --profile-name=PROFILE-NAME short name for benchmark scenario --results=DIR put results under DIR (../benchmarks) --seivot-branch=DIR use DIR as the seivot branch (default: installed seivot) --seivot-log=SEIVOT-LOG seivot log setting --sftp-delay=SFTP-DELAY add artifical delay to sftp transfers (in milliseconds) --size=PAIR add PAIR to list of sizes to benchmark (e.g., 10g/1m) --use-sftp-repository access the repository over SFTP (requires ssh to localhost to work) --use-sftp-root access the live data over SFTP (requires ssh to localhost to work) --verify verify restores --version show program's version number and exit --with-encryption run benchmark using encryption ENVIRONMENT
TMPDIR This variable must be set. It controls where the temporary files (generated test data) is stored. If this variable was not set, they'd be put into /tmp, which easily fills up, to the detriment of the entire system. Thus. obnam-benchmark requires that the lo- cation is set explicitly. (You can still use /tmp if you want, but you have to set TMPDIR explicitly.) FILES
../benchmarks/ The default directory where results of the benchmark are stored, in a subdirectory named after the branch and revision numbers. EXAMPLE
To run a small benchmark: TMPDIR=/var/tmp obnam-benchmark --size=10m/1m To run a benchmark using existing data: TMPDIR=/var/tmp obnam-benchmark --use-existing=$HOME/Mail To view the currently available benchmark results: seivots-summary ../benchmarks/*/*mail*.seivot | less -S seivots-summary ../benchmarks/*/*media*.seivot | less -S (You need to run seivots-summary once per usage profile.) SEE ALSO
obnam(1), seivot(1), seivots-summary(1). OBNAM-BENCHMARK(1)