From 80a356951efdc3fdf0aed0b43780711969312743 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sat, 2 Mar 2019 19:44:56 +0100
Subject: Adding upstream version 20190301.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 share/man/cephfs-snap.1 | 117 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 117 insertions(+)
 create mode 100644 share/man/cephfs-snap.1

(limited to 'share/man/cephfs-snap.1')

diff --git a/share/man/cephfs-snap.1 b/share/man/cephfs-snap.1
new file mode 100644
index 0000000..8bc699f
--- /dev/null
+++ b/share/man/cephfs-snap.1
@@ -0,0 +1,117 @@
+'\" t
+.\"     Title: cephfs-snap
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 20171101
+.\"    Manual: Open Infrastructure
+.\"    Source: storage-tools
+.\"  Language: English
+.\"
+.TH "CEPHFS\-SNAP" "1" "20171101" "storage\-tools" "Open Infrastructure"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+cephfs-snap \- create CephFS snapshots periodically
+.SH "SYNOPSIS"
+.sp
+\fBcephfs\-snap\fR
+.sp
+\fBcephfs\-snap\fR [hourly|daily|weekly|monthly]
+.SH "DESCRIPTION"
+.sp
+CephFS supports creating snapshots of the filesystem as a simple means of backups\&.
+.sp
+The cephfs\-snap program is a simple tool to do this periodically\&.
+.SH "CONFIGURATION"
+.sp
+cephfs\-snap is configured in /etc/default/storage\-tools\&. The following variables are used:
+.PP
+\fBCEPHFS_SNAP\fR
+.RS 4
+Boolean, either true or false\&. If set to false (default), cephfs will do nothing\&.
+.RE
+.PP
+\fBCEPHFS_SNAP_DIRECTORIES\fR
+.RS 4
+List of one or more space separated directories\&. If no directory is specified, cephfs\-snap will do nothing\&.
+.RE
+.PP
+\fBCEPHFS_SNAP_HOURLY\fR
+.RS 4
+Integer, number of how many most recent hourly snapshots are to be kept at any given time\&. Any older snapshots will be removed\&. Note: specify one more than you wan to keep, e\&.g\&. 25 for one day of hourly snapshots alongside the most current one\&.
+.RE
+.PP
+\fBCEPHFS_SNAP_DAILY\fR
+.RS 4
+Integer, number of how many most recent daily snapshots are to be kept at any given time\&.
+.RE
+.PP
+\fBCEPHFS_SNAP_WEEKLY\fR
+.RS 4
+Integer, number of how many most recent weekly snapshots are to be kept at any given time\&.
+.RE
+.PP
+\fBCEPHFS_SNAP_MONTHLY\fR
+.RS 4
+Integer, number of how many most recent monthly snapshots are to be kept at any given time\&.
+.RE
+.PP
+\fBCEPHFS_SNAP_YEARLY\fR
+.RS 4
+Integer, number of how many most recent yearly snapshots are to be kept at any given time\&.
+.RE
+.PP
+\fBIRK_TARGETS\fR
+.RS 4
+List of space separated IRC channels to send notifications to, e\&.g\&.:
+irc://irc\&.oftc\&.net:6668/open\-infrastructure
+.RE
+.SH "FILES"
+.sp
+The following files are used:
+.PP
+\fB/etc/cron\&.d/cephfs\-snap\fR
+.RS 4
+Cron file\&.
+.RE
+.PP
+\fB/etc/open\-infrastructure/ceph\-tools\&.conf\fR
+.RS 4
+Configuration file\&.
+.RE
+.PP
+\fB/var/log/storage\-tools/cephfs\-snap\fR
+.RS 4
+Log files\&.
+.RE
+.SH "SEE ALSO"
+.sp
+storage\-tools(7)\&.
+.SH "HOMEPAGE"
+.sp
+More information about storage\-tools and the Open Infrastructure project can be found on the homepage at https://open\-infrastructure\&.net\&.
+.SH "CONTACT"
+.sp
+Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List <software@lists\&.open\-infrastructure\&.net>\&.
+.sp
+Debian specific bugs can also be reported in the Debian Bug Tracking System at https://bugs\&.debian\&.org\&.
+.SH "AUTHORS"
+.sp
+storage\-tools was written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net>\&.
-- 
cgit v1.2.3