File 675e7902e449cc00b0a459a6ec17a0e044ac966b.patch of Package casync

Overview Repositories Revisions Requests Users Attributes Meta

File 675e7902e449cc00b0a459a6ec17a0e044ac966b.patch of Package casync (Revision a80920a19a588635339a8e38c355cc86)

Currently displaying revision a80920a19a588635339a8e38c355cc86 , Show latest

From 675e7902e449cc00b0a459a6ec17a0e044ac966b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= <zbyszek@in.waw.pl>
Date: Tue, 20 Jun 2017 17:38:04 -0400
Subject: [PATCH] doc: add casync man page based on --help output (#30)

Use "sphinx-build-3 -b man doc build/doc" to build.
---
 doc/casync.rst |  98 ++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/conf.py    | 112 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/index.rst  |  18 ++++++++++
 3 files changed, 228 insertions(+)
 create mode 100644 doc/casync.rst
 create mode 100644 doc/conf.py
 create mode 100644 doc/index.rst

diff --git a/doc/casync.rst b/doc/casync.rst
new file mode 100644
index 0000000..4a27630
--- /dev/null
+++ b/doc/casync.rst
@@ -0,0 +1,98 @@
+:orphan:
+
+casync manual page
+==================
+
+Synopsis
+--------
+
+| **casync** [*OPTIONS*...] make [*ARCHIVE* | *ARCHIVE_INDEX* | *BLOB_INDEX*] [*PATH*]
+| **casync** [*OPTIONS*...] extract [*ARCHIVE* | *ARCHIVE_INDEX* | *BLOB_INDEX*] [*PATH*]
+| **casync** [*OPTIONS*...] list [*ARCHIVE* | *ARCHIVE_INDEX* | *DIRECTORY*]
+| **casync** [*OPTIONS*...] mtree [*ARCHIVE* | *ARCHIVE_INDEX* | *DIRECTORY*]
+| **casync** [*OPTIONS*...] stat [*ARCHIVE* | *ARCHIVE_INDEX* | *DIRECTORY*] [*PATH*]
+| **casync** [*OPTIONS*...] digest [*ARCHIVE* | *BLOB* | *ARCHIVE_INDEX* | *BLOB_INDEX* | *DIRECTORY*]
+| **casync** [*OPTIONS*...] mkdev [*BLOB* | *BLOB_INDEX*] [*NODE*]
+
+Description
+-----------
+
+Content-Addressable Data Synchronization Tool
+
+Options
+-------
+
+General options:
+
+--help, -h                      Show this help
+--verbose, -v                   Show terse status information during runtime
+--store=PATH                    The primary chunk store to use
+--extra-store=PATH              Additional chunk store to look for chunks in
+--chunk-size=<[MIN]:AVG:[MAX]>  The minimal/average/maximum number of bytes in a chunk
+--seed=PATH                     Additional file or directory to use as seed
+--rate-limit-bps=LIMIT          Maximum bandwidth in bytes/s for remote communication
+--exclude-nodump=no             Don't exclude files with chattr(1)'s +d **nodump** flag when creating archive
+--exclude-submounts=yes         Exclude submounts when creating archive
+--reflink=no                    Don't create reflinks from seeds when extracting
+--hardlink=yes                  Create hardlinks from seeds when extracting
+--punch-holes=no                Don't create sparse files when extracting
+--delete=no                     Don't delete existing files not listed in archive after extraction
+--undo-immutable=yes            When removing existing files, undo chattr(1)'s +i 'immutable' flag when extracting
+--seed-output=no                Don't implicitly add pre-existing output as seed when extracting
+--recursive=no                  List non-recursively
+--uid-shift=<yes|SHIFT>         Shift UIDs/GIDs
+--uid-range=RANGE               Restrict UIDs/GIDs to range
+
+Input/output selector:
+
+--what=archive          Operate on archive file
+--what=archive-index    Operate on archive index file
+--what=blob             Operate on blob file
+--what=blob-index       Operate on blob index file
+--what=directory        Operate on directory
+
+Archive feature sets:
+
+--with=best             Store most accurate information
+--with=unix             Store UNIX baseline information
+--with=fat              Store FAT information
+--with=chattr           Store chattr(1) file attributes
+--with=fat-attrs        Store FAT file attributes
+--with=privileged       Store file data that requires privileges to restore
+--with=fuse             Store file data that can exposed again via 'casync mount'
+
+(and similar: ``--without=fat-attrs``, ``--without=privileged``, ...)
+
+Individual archive features:
+
+--with=<16bit-uids>        Store reduced 16bit UID/GID information
+--with=<32bit-uids>        Store full 32bit UID/GID information
+--with=<user-names>        Store user/group names
+--with=<sec-time>          Store timestamps in 1s granularity
+--with=<usec-time>         Store timestamps in 1µs granularity
+--with=<nsec-time>         Store timestamps in 1ns granularity
+--with=<2sec-time>         Store timestamps in 2s granularity
+--with=<read-only>         Store per-file read only flag
+--with=<permissions>       Store full per-file UNIX permissions
+--with=<symlinks>          Store symbolic links
+--with=<device-nodes>      Store block and character device nodes
+--with=<fifos>             Store named pipe nodes
+--with=<sockets>           Store AF_UNIX file system socket nodes
+--with=<flag-hidden>       Store FAT hidden file flag
+--with=<flag-system>       Store FAT system file flag
+--with=<flag-archive>      Store FAT archive file flag
+--with=<flag-append>       Store append-only file flag
+--with=<flag-noatime>      Store disable access time file flag
+--with=<flag-compr>        Store enable compression file flag
+--with=<flag-nocow>        Store disable copy-on-write file flag
+--with=<flag-nodump>       Store disable dumping file flag
+--with=<flag-dirsync>      Store synchronous directory flag
+--with=<flag-immutable>    Store immutable file flag
+--with=<flag-sync>         Store synchronous file flag
+--with=<flag-nocomp>       Store disable compression file flag
+--with=<flag-projinherit>  Store project quota inheritance flag
+--with=<xattrs>            Store extended file attributes
+--with=<acl>               Store file access control lists
+--with=<fcaps>             Store file capabilities
+
+(and similar: ``--without=16bit-uids``, ``--without=32bit-uids``, ...)
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..1cfcf91
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,112 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# casync documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun 20 16:46:39 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.todo',
+    'sphinx.ext.githubpages']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'casync'
+author = ''
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1'
+# The full version, including alpha/beta/rc tags.
+release = '1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'casyncdoc'
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('casync', 'casync', 'casync Documentation',
+     [], 1)
+]
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..34bbc1c
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,18 @@
+.. casync documentation master file, created by
+   sphinx-quickstart on Tue Jun 20 16:46:39 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to casync's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

Places

File 675e7902e449cc00b0a459a6ec17a0e044ac966b.patch of Package casync (Revision a80920a19a588635339a8e38c355cc86)

Places