From: Cheng-Ling Lai <jameslai.tech@gmail.com>
Date: Thu, 16 Jul 2026 06:15:41 +0000 (+0800)
Subject: Add a manpage for snapper-sync
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8677cf9e938f07625e3d71d4c8ee1c2e777ecd62;p=thirdparty%2Fsnapper.git

Add a manpage for snapper-sync
---

diff --git a/configure.ac b/configure.ac
index f15bf28e..013a79c7 100644
--- a/configure.ac
+++ b/configure.ac
@@ -242,6 +242,7 @@ AC_CONFIG_FILES([
 	doc/snapperd.xml:doc/snapperd.xml.in
 	doc/snapper-configs.xml:doc/snapper-configs.xml.in
 	doc/snbk.xml:doc/snbk.xml.in
+	doc/snapper-sync.xml:doc/snapper-sync.xml.in
 	doc/snapper-backup-configs.xml:doc/snapper-backup-configs.xml.in
 	doc/snapper-zypp-plugin.xml:doc/snapper-zypp-plugin.xml.in
 	doc/snapper-zypp-plugin.conf.xml:doc/snapper-zypp-plugin.conf.xml.in
diff --git a/dists/debian/snapper-backup.manpages b/dists/debian/snapper-backup.manpages
index f1f434ba..a937b71d 100644
--- a/dists/debian/snapper-backup.manpages
+++ b/dists/debian/snapper-backup.manpages
@@ -1,2 +1,3 @@
 debian/tmp/usr/share/man/man8/snbk.8
+debian/tmp/usr/share/man/man8/snapper-sync.8
 debian/tmp/usr/share/man/man5/snapper-backup-configs.5
diff --git a/doc/Makefile.am b/doc/Makefile.am
index f6fe4220..640e3e10 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,7 +4,8 @@
 
 if ENABLE_DOC
 
-man_MANS = snapper.8 snapperd.8 snapper-configs.5 snbk.8 snapper-backup-configs.5
+man_MANS = snapper.8 snapperd.8 snapper-configs.5		\
+	   snbk.8 snapper-sync.8 snapper-backup-configs.5
 
 if HAVE_PAM
 man_MANS += pam_snapper.8
diff --git a/doc/snapper-sync.xml.in b/doc/snapper-sync.xml.in
new file mode 100644
index 00000000..c0791c91
--- /dev/null
+++ b/doc/snapper-sync.xml.in
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry id='snapper-sync8' xmlns:xlink="http://www.w3.org/1999/xlink">
+
+  <refentryinfo>
+    <date>2026-07-16</date>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>snapper-sync</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class='date'>2026-07-16</refmiscinfo>
+    <refmiscinfo class='version'>@VERSION@</refmiscinfo>
+    <refmiscinfo class='manual'>Filesystem Snapshot Management</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>snapper-sync</refname>
+    <refpurpose>Script to synchronize the highest snapshot number</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv id='synopsis'>
+    <cmdsynopsis>
+      <command>snapper-sync</command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id='description'>
+    <title>DESCRIPTION</title>
+    <para><command>snapper-sync</command> is a script to synchronize the highest snapshot
+    number across the source and backup target devices, avoiding a potential snapshot
+    number collision after restoration. For details, please refer to the
+    <citerefentry>
+      <refentrytitle>snbk</refentrytitle><manvolnum>8</manvolnum>
+    </citerefentry>
+    documentation</para>
+  </refsect1>
+
+  <refsect1 id='exit_status'>
+    <title>EXIT STATUS</title>
+    <para>Normally the exit status is 0. If an error occurred the exit status is 1.</para>
+  </refsect1>
+
+  <refsect1 id='homepage'>
+    <title>HOMEPAGE</title>
+    <para><ulink url='http://snapper.io/'>http://snapper.io/</ulink></para>
+  </refsect1>
+
+  <refsect1 id='authors'>
+    <title>AUTHORS</title>
+    <para>Arvin Schnell <email>aschnell@suse.com</email></para>
+  </refsect1>
+
+  <refsect1 id='see_also'>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry><refentrytitle>snbk</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>
diff --git a/snapper.spec.in b/snapper.spec.in
index b6974acd..53371e86 100644
--- a/snapper.spec.in
+++ b/snapper.spec.in
@@ -380,6 +380,7 @@ A backup program for snapshots created by snapper.
 %{_unitdir}/snapper-timeline.timer.d
 %{_unitdir}/snapper-timeline.timer.d/10-snapper-sync-override.conf
 %{_mandir}/*/snbk.8*
+%{_mandir}/*/snapper-sync.8*
 %{_mandir}/*/snapper-backup-configs.5*
 %dir %{_datadir}/bash-completion
 %dir %{_datadir}/bash-completion/completions