From 65ebf949d1aa4c15ed5678b67f6c9de89db818b8 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Tue, 3 May 2016 15:54:35 +0200 Subject: [PATCH] documentation: cosmetics: groff: consistently use minus "\-" instead of hyphen "-" where applicable --- doc/btrbk.1 | 28 ++++++++++---------- doc/btrbk.conf.5 | 60 +++++++++++++++++++++--------------------- doc/ssh_filter_btrbk.1 | 4 +-- 3 files changed, 46 insertions(+), 46 deletions(-) diff --git a/doc/btrbk.1 b/doc/btrbk.1 index 1949c79..67fc308 100644 --- a/doc/btrbk.1 +++ b/doc/btrbk.1 @@ -23,10 +23,10 @@ backups from one source to multiple destinations. Snapshots as well as backup subvolume names are created in form: .PP .RS 4 -.[_N] +.[_N] .RE .PP -Where is identical to the source subvolume name, +Where is identical to the source subvolume name, unless the configuration option \fIsnapshot_name\fR is set. The is either "YYYYMMDD" or "YYYYMMDDThhmm" (dependent of the \fItimestamp_format\fR configuration option), where "YYYY" is the @@ -90,13 +90,13 @@ and trace. .PP \-t, \-\-table .RS 4 -Print output in table format (shortcut for "--format=table"). +Print output in table format (shortcut for "\-\-format=table"). .RE .PP \-\-format table|long|raw .RS 4 Print output in specified format. If set to "raw", prints -space-separated key="value" pairs (machine-readable). Affects output +space-separated key="value" pairs (machine readable). Affects output format for \fBrun\fR, \fBdryrun\fR, \fBlist\fR and \fBtree\fR commands. Useful for further exporting/scripting. .RE @@ -181,12 +181,12 @@ using btrbk after swapping your backup disk with the archive disk. Note that this feature needs a \fBlinux kernel >=4.4\fR to work correctly! Kernels >=4.1 and <4.4 have a bug when re-sending subvolumes (the archived subvolumes will have incorrect received_uuid, -see ), so -make sure you run a recent kernel. +see ), +so make sure you run a recent kernel. .PP Known bugs: If you want to use nested subvolumes on the target filesystem, you need to create them by hand (e.g. by running "btrfs -subvolume create /dir"). Check the output of --dry-run if +subvolume create /dir"). Check the output of \-\-dry\-run if unsure. .RE .PP @@ -266,7 +266,7 @@ Print new files since subvolume for subvolume . .RE .PP .B config -print|print-all +print|print\-all .RS 4 Prints the parsed configuration file. Use the \fI\-\-format\fR command line option to switch between different output formats. @@ -274,30 +274,30 @@ line option to switch between different output formats. .SH FILTER STATEMENTS Filter arguments are accepted in form: .PP -[hostname:] +[hostname:] .RS 4 Matches all subvolumes and targets of a \fIvolume\fR configuration section. .RE .PP -[hostname:]/ +[hostname:]/ .RS 4 Matches the specified subvolume and all targets of a \fIsubvolume\fR configuration section. .RE .PP -[hostname:] +[hostname:] .RS 4 Matches all targets of a \fItarget\fR configuration section. .RE .PP -[hostname:]/ +[hostname:]/ .RS 4 Matches a single target of a \fItarget\fR section within a -\fIsubvolume\fR section with given . +\fIsubvolume\fR section with given . .RE .PP - + .RS 4 Matches the \fIgroup\fR configuration option of a \fIvolume\fR, \fIsubvolume\fR or \fItarget\fR section. diff --git a/doc/btrbk.conf.5 b/doc/btrbk.conf.5 index f8a4df1..006d16e 100644 --- a/doc/btrbk.conf.5 +++ b/doc/btrbk.conf.5 @@ -21,22 +21,22 @@ superseding the values set in upper-level sections. This means that global options must be set before any sections are defined. .SH SECTIONS .PP -\fBvolume\fR | +\fBvolume\fR | .RS 4 Directory of a btrfs volume containing the source subvolume(s) to be -backed up. \fI\fR must be an absolute path and point -to a btrfs volume (or subvolume). Usually the mount point of a btrfs -filesystem mounted with the \fIsubvolid=0\fR option. +backed up. \fI\fR must be an absolute path and +point to a btrfs volume (or subvolume). Usually the mount point of a +btrfs filesystem mounted with the \fIsubvolid=0\fR option. .RE .PP -\fBsubvolume\fR +\fBsubvolume\fR .RS 4 -Subvolume to be backed up, relative to the \fI\fR +Subvolume to be backed up, relative to the \fI\fR specified in the \fIvolume\fR section. Multiple \fIsubvolume\fR sections are allowed within \fIvolume\fR sections. .RE .PP -\fBtarget\fR | +\fBtarget\fR | .RS 4 Target type and directory where the backup subvolumes are to be created. See the TARGET TYPES section for supported @@ -49,7 +49,7 @@ resulting configuration). .RE .PP For the \fIvolume\fR and \fItarget\fR sections, you can specify a -ssh-url instead of a local directory. The syntax for \fI\fR is: +ssh\-url instead of a local directory. The syntax for \fI\fR is: .PP .RS 4 .nf @@ -63,14 +63,14 @@ convenience, "ssh:///" can also be specified as ":". .PP Note that btrfs is very picky on file names (mainly for security -reasons), only the characters [0-9] [a-z] [A-Z] and "._+-@" are +reasons), only the characters [0\-9] [a\-z] [A\-Z] and "._+\-@" are allowed. .RE .SH OPTIONS .PP \fBtransaction_log\fR .RS 4 -If set, all transactions (snapshot create, subvolume send-receive, +If set, all transactions (snapshot create, subvolume send\-receive, subvolume delete) as well as abort messages are logged to , in a space-separated table format: "localtime type status duration target_url source_url parent_url message". @@ -84,7 +84,7 @@ syslog facility name, like \[lq]daemon\[rq] or \[lq]local7\[rq]. The program name used in the messages is "btrbk". .RE .PP -\fBtimestamp_format\fR short|long|long-iso +\fBtimestamp_format\fR short|long|long\-iso .RS 4 Timestamp format used as postfix for new snapshot subvolume names. Defaults to \[lq]short\[rq]. @@ -93,24 +93,24 @@ names. Defaults to \[lq]short\[rq]. YYYYMMDD[_N] (e.g. "20150825", "20150825_1") .IP \fBlong\fR 10 YYYYMMDDhhmm[_N] (e.g. "20150825T1531") -.IP \fBlong-iso\fR 10 +.IP \fBlong\-iso\fR 10 YYYYMMDDhhmmss\[t+-]hhmm[_N] (e.g. "20150825T153123+0200") .PP Note that a postfix "_N" is appended to the timestamp if a snapshot or backup already exists with the timestamp of current date/time. .PP -Use \[lq]long-iso\[rq] if you want to make sure that btrbk never +Use \[lq]long\-iso\[rq] if you want to make sure that btrbk never creates ambiguous time stamps (which can happen if multiple snapshots are created during a daylight saving time clock change). .PP -Note that using \[lq]long-iso\[rq] has implications on the scheduling, -see RETENTION POLICY (caveats) below. +Note that using \[lq]long\-iso\[rq] has implications on the +scheduling, see RETENTION POLICY (caveats) below. .RE .PP \fBsnapshot_dir\fR .RS 4 Directory in which the btrfs snapshots are created, relative to -\fI\fR of the \fIvolume\fR section. Note that btrbk +\fI\fR of the \fIvolume\fR section. Note that btrbk does not autmatically create this directory, and the snapshot creation will fail if it is not present. .RE @@ -119,7 +119,7 @@ will fail if it is not present. .RS 4 Base name of the created snapshot (and backup). This option is only valid in the \fIsubvolume\fR section. Defaults to -\fI\fR. +\fI\fR. .RE .PP \fBsnapshot_create\fR always|onchange|ondemand|no @@ -183,7 +183,7 @@ Defines on what day a backup/snapshot is considered as a weekly backup. Defaults to \[lq]sunday\[rq]. .RE .PP -\fBgroup\fR [,]... +\fBgroup\fR [,]... .RS 4 Add the current section (volume, subvolume or target) to a user-defined group, which can be used as filter for several btrbk @@ -199,9 +199,9 @@ which is usually not desired. .PP \fBssh_user\fR .RS 4 -Remote username for ssh. Defaults to \[lq]root\[rq]. Note that you will -have to make sure that the remote user is able to run /sbin/btrfs -(which needs root privileges). +Remote username for ssh. Defaults to \[lq]root\[rq]. Note that you +will have to make sure that the remote user is able to run +"/sbin/btrfs" (which needs root privileges). .RE .PP \fBssh_port\fR @@ -219,7 +219,7 @@ Enables or disables the compression of ssh connections. Defaults to \fBssh_cipher_spec\fR .RS 4 Selects the cipher specification for encrypting the session -(comma-separated list of ciphers in order of preference). See the "-c +(comma-separated list of ciphers in order of preference). See the "\-c cipher_spec" option in ssh(1) for more information. Defaults to \[lq]default\[rq] (the ciphers specified in \fIssh_config\fR). .RE @@ -263,8 +263,8 @@ With the following semantics: Defines how many hours back hourly backups should be preserved. The first backup of an hour is considered an hourly backup. Note that if you use scheduling, make sure to also set -\fItimestamp_format\fR to \[lq]long\[rq] or \[lq]long-iso\[rq], or the -scheduler will interpret the time as "00:00" (midnight). +\fItimestamp_format\fR to \[lq]long\[rq] or \[lq]long\-iso\[rq], or +the scheduler will interpret the time as "00:00" (midnight). .RE .PP .B daily @@ -311,27 +311,27 @@ instance on the backup server), it makes perfectly sense to run btrbk with different local time on the clients, in order to make sure the backups from all the remote hosts are preserved for "midnight", and not at "00:00 UTC" (which would be "14:00" in Honolulu). If you want -this behaviour, do NOT use "timestamp_format long-iso". +this behaviour, do NOT use "timestamp_format long\-iso". .IP \[bu] 2 -If "timestamp_format long-iso" is set, running btrbk from different +If "timestamp_format long\-iso" is set, running btrbk from different time zones leads to different interpretation of "first in day, week, month, or year". Make sure to run btrbk with the same time zone on every host, e.g. by setting the TZ environment variable (see tzset(3)). .SH TARGET TYPES .PP -\fBsend-receive\fR +\fBsend\-receive\fR .RS 4 Backup to a btrfs filesystem, using "btrfs send/receive". This is the -recommended (standard) target type. The \fI\fR must +recommended (standard) target type. The \fI\fR must be an absolute path and point to a btrfs volume (or subvolume), or to -a directory within a subvolume. See btrfs-send(8), btrfs-receive(8). +a directory within a subvolume. See btrfs\-send(8), btrfs\-receive(8). .RE .PP \fBraw\fR \fI*experimental*\fR .RS 4 Backup to a raw (filesystem independent) file from the output of -btrfs-send(8), with optional compression and encryption. +btrfs\-send(8), with optional compression and encryption. .PP Note that the target preserve mechanism is currently disabled for raw backups (btrbk does not delete any raw files)! diff --git a/doc/ssh_filter_btrbk.1 b/doc/ssh_filter_btrbk.1 index 3f8d0d1..b1f124e 100644 --- a/doc/ssh_filter_btrbk.1 +++ b/doc/ssh_filter_btrbk.1 @@ -1,4 +1,4 @@ -.TH "ssh_filter_btrbk" "1" "2016-04-23" "btrbk v0.23.0" "" +.TH "ssh_filter_btrbk" "1" "2016-05-03" "btrbk v0.23.1-dev" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -51,7 +51,7 @@ to \[lq]all\[rq], and for backup targets if .PP \-i, \-\-info .RS 4 -Allow informative commands: "btrfs subvolume find-new", "btrfs +Allow informative commands: "btrfs subvolume find\-new", "btrfs filesystem usage". This is used by btrbk \fIinfo\fR and \fIdiff\fR commands. .RE