From dfabd4e8566a0b73f5a4cddcd1c88ec1ef542406 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Tue, 26 Mar 2019 14:29:35 +0100 Subject: [PATCH] documentation: btrbk.conf.5: move info about allowed characters to top section --- doc/btrbk.conf.5.asciidoc | 34 +++++++++++----------------------- 1 file changed, 11 insertions(+), 23 deletions(-) diff --git a/doc/btrbk.conf.5.asciidoc b/doc/btrbk.conf.5.asciidoc index 68705e1..a6e6e65 100644 --- a/doc/btrbk.conf.5.asciidoc +++ b/doc/btrbk.conf.5.asciidoc @@ -36,6 +36,14 @@ global options must be set before any sections are defined. Blank lines are ignored. A hash character (#) starts a comment extending until end of line. +Whitespace or unicode characters are not allowed for file +names. Allowed characters are: + + [0-9] [a-z] [A-Z] and "._+-@" + +This is for sanity/safety/security reasons, we apologize for the +inconvenience. + SECTIONS -------- @@ -72,37 +80,17 @@ btrfs-progs < 4.16. declaration already exists (hint: run "btrbk config print" to see the resulting configuration). +If a '' is specified, btrbk actions (shell commands) are executed +remotely via ssh, using the <<_ssh_options,SSH Options>> described +below. Accepted formats are: -:: - Run actions locally. -+ --- -Note that 'whitespace' or 'unicode' characters are NOT allowed -for file names. Allowed characters are: - - [0-9] [a-z] [A-Z] and "._+-@" - -This is for sanity/safety/security reasons, we apologize for the -inconvenience. --- - -:: - Run actions remotely via ssh. - Either: -+ --- ssh:/// : -If a '' is specified, btrbk actions for '' (shell -commands) are executed via ssh, using the "ssh_" options described -below. - Note that btrbk keeps mountpoint and btrfs-tree information per 'hostname': specifying different 'ssh_port' for the same host, e.g. for several virtual machines listening on same address, will NOT work. If you need this, define alias host names for each vm. --- OPTIONS