From 8cc97b429cbe18b733f7c12c144ebf611c751005 Mon Sep 17 00:00:00 2001 From: Christoph Anton Mitterer Date: Tue, 15 Nov 2022 23:33:48 +0100 Subject: [PATCH] documentation: use actual path for ssh_filter_btrbk MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In it’s manpage, use the actual installation pathname of `ssh_filter_btrbk.sh`. In `README.md`, which should be readable without building, use the usual pathname, which is `/usr/share/btrbk/scripts/ssh_filter_btrbk.sh`. Signed-off-by: Christoph Anton Mitterer --- README.md | 6 +++--- doc/Makefile | 7 +++++++ ...ter_btrbk.1.asciidoc => ssh_filter_btrbk.1.asciidoc.in} | 2 +- 3 files changed, 11 insertions(+), 4 deletions(-) rename doc/{ssh_filter_btrbk.1.asciidoc => ssh_filter_btrbk.1.asciidoc.in} (94%) diff --git a/README.md b/README.md index edf8d45..207f705 100644 --- a/README.md +++ b/README.md @@ -555,14 +555,14 @@ to run it whenever the key is used for authentication. Example "/root/.ssh/authorized_keys": # example backup source (also allowing deletion of old snapshots) - command="/backup/scripts/ssh_filter_btrbk.sh -l --source --delete",restrict ... + command="/usr/share/btrbk/scripts/ssh_filter_btrbk.sh -l --source --delete",restrict ... # example backup target (also allowing deletion of old snapshots) - command="/backup/scripts/ssh_filter_btrbk.sh -l --target --delete",restrict ... + command="/usr/share/btrbk/scripts/ssh_filter_btrbk.sh -l --target --delete",restrict ... # example fetch-only backup source (snapshot_preserve_min=all, snapshot_create=no), # restricted to subvolumes within /home or /data - command="/backup/scripts/ssh_filter_btrbk.sh -l --send -p /home -p /data",restrict ... + command="/usr/share/btrbk/scripts/ssh_filter_btrbk.sh -l --send -p /home -p /data",restrict ... [ssh_filter_btrbk(1)]: https://digint.ch/btrbk/doc/ssh_filter_btrbk.1.html diff --git a/doc/Makefile b/doc/Makefile index c8205bb..25ec464 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -10,6 +10,7 @@ PREFIX ?= /usr DOCDIR = $(PREFIX)/share/doc/$(PN) MAN1DIR = $(PREFIX)/share/man/man1 MAN5DIR = $(PREFIX)/share/man/man5 +SCRIPTDIR ?= $(PREFIX)/share/$(PN)/scripts ifeq ($(COMPRESS), yes) DOCS := $(addsuffix .gz,$(DOCS)) @@ -17,6 +18,9 @@ ifeq ($(COMPRESS), yes) MAN_MAN5 := $(addsuffix .gz,$(MAN_MAN5)) endif +replace_vars = sed \ + -e "s|@SCRIPTDIR@|$(SCRIPTDIR)|g" + # convert using "asciidoctor": ASCIIDOCTOR_MANPAGE = asciidoctor -d manpage -b manpage ASCIIDOCTOR_HTML = asciidoctor -b html5 -d article @@ -57,3 +61,6 @@ clean: %.html : %.asciidoc SOURCE_DATE_EPOCH=$(call source_date_epoch,$<) $(ASCIIDOCTOR_HTML) -o $@ $< + +%.asciidoc : %.asciidoc.in + $(replace_vars) ssh_filter_btrbk.1.asciidoc.in > ssh_filter_btrbk.1.asciidoc diff --git a/doc/ssh_filter_btrbk.1.asciidoc b/doc/ssh_filter_btrbk.1.asciidoc.in similarity index 94% rename from doc/ssh_filter_btrbk.1.asciidoc rename to doc/ssh_filter_btrbk.1.asciidoc.in index 0287409..0780823 100644 --- a/doc/ssh_filter_btrbk.1.asciidoc +++ b/doc/ssh_filter_btrbk.1.asciidoc.in @@ -45,7 +45,7 @@ The following commands are always allowed: Example line in /root/.ssh/authorized_keys on a backup target host: - command="ssh_filter_btrbk.sh --target --delete --restrict-path /mnt/btr_backup",restrict ssh-rsa AAAAB3NzaC1...hwumXFRQBL btrbk@example.org + command="@SCRIPTDIR@/ssh_filter_btrbk.sh --target --delete --restrict-path /mnt/btr_backup",restrict ssh-rsa AAAAB3NzaC1...hwumXFRQBL btrbk@example.org OPTIONS