summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikolaus Rath <Nikolaus@rath.org>2018-12-28 19:58:08 +0000
committerNikolaus Rath <Nikolaus@rath.org>2018-12-28 19:58:08 +0000
commitb832d28084164679267b3d852ccc9b8f1acef04a (patch)
tree0fa1189af45fab03e1b2f0d40126455ac96095bd
parente23ce8bd57dc9ab46072803975ea7a00347522f9 (diff)
New upstream version 2.33+dfsg
-rw-r--r--Changes.txt4
-rw-r--r--PKG-INFO8
-rw-r--r--README.rst6
-rw-r--r--contrib/expire_backups.14
-rw-r--r--contrib/pcp.14
-rw-r--r--doc/latex/Makefile72
-rw-r--r--doc/latex/manual.aux563
-rw-r--r--doc/latex/manual.out63
-rw-r--r--doc/latex/manual.pdfbin287682 -> 0 bytes
-rw-r--r--doc/latex/manual.tex2462
-rw-r--r--doc/latex/manual.toc211
-rw-r--r--doc/latex/python.ist10
-rw-r--r--doc/latex/sphinx.sty1939
-rw-r--r--doc/latex/sphinxhighlight.sty102
-rw-r--r--doc/latex/sphinxhowto.cls58
-rw-r--r--doc/latex/sphinxmanual.cls64
-rw-r--r--doc/latex/tabulary.sty452
-rw-r--r--doc/man/fsck.s3ql.14
-rw-r--r--doc/man/mkfs.s3ql.14
-rw-r--r--doc/man/mount.s3ql.14
-rw-r--r--doc/man/s3ql_oauth_client.14
-rw-r--r--doc/man/s3ql_verify.14
-rw-r--r--doc/man/s3qladm.14
-rw-r--r--doc/man/s3qlcp.14
-rw-r--r--doc/man/s3qlctrl.14
-rw-r--r--doc/man/s3qllock.14
-rw-r--r--doc/man/s3qlrm.14
-rw-r--r--doc/man/s3qlstat.14
-rw-r--r--doc/man/umount.s3ql.14
-rw-r--r--doc/manual.pdfbin287682 -> 304931 bytes
-rw-r--r--rst/about.rst3
-rw-r--r--rst/faq.rst254
-rw-r--r--rst/include/postman.rst2
-rw-r--r--rst/index.rst1
-rw-r--r--rst/installation.rst20
-rw-r--r--rst/issues.rst23
-rw-r--r--rst/man/expire_backups.rst2
-rw-r--r--rst/man/pcp.rst2
-rw-r--r--rst/mount.rst3
-rw-r--r--rst/resources.rst6
-rw-r--r--src/s3ql.egg-info/PKG-INFO8
-rw-r--r--src/s3ql.egg-info/SOURCES.txt56
-rw-r--r--src/s3ql/__init__.py2
-rw-r--r--src/s3ql/fsck.py4
-rw-r--r--tests/.pytest_cache/.gitignore2
-rw-r--r--tests/.pytest_cache/README.md8
-rw-r--r--tests/.pytest_cache/v/cache/lastfailed1
-rw-r--r--tests/.pytest_cache/v/cache/nodeids376
-rwxr-xr-xtests/t4_fuse.py9
-rw-r--r--tests/t5_cache.py6
50 files changed, 3630 insertions, 3228 deletions
diff --git a/Changes.txt b/Changes.txt
index cb5bebc..525fadf 100644
--- a/Changes.txt
+++ b/Changes.txt
@@ -1,3 +1,7 @@
+2018-12-28, S3QL 2.33
+
+ * Fixed a sporadic test failure in t5_cache.py.
+
2018-11-06, S3QL 2.32
* Fixed a potential bug in s3qlrm that would probably lead to a
diff --git a/PKG-INFO b/PKG-INFO
index 8e42059..1b55302 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: s3ql
-Version: 2.32
+Version: 2.33
Summary: a full-featured file system for online data storage
Home-page: https://bitbucket.org/nikratio/s3ql/
Author: Nikolaus Rath
@@ -9,7 +9,7 @@ License: GPLv3
Download-URL: https://bitbucket.org/nikratio/s3ql/downloads
Description: ..
NOTE: We cannot use sophisticated ReST syntax here because this
- file is rendered by Bitbucket.
+ file is rendered by GitHub.
======
S3QL
@@ -149,7 +149,7 @@ Description: ..
Contributing
============
- The S3QL source code is available both on GitHub_ and BitBucket_.
+ The S3QL source code is available on GitHub_.
Professional Support
--------------------
@@ -158,11 +158,9 @@ Description: ..
.. _`S3QL User's Guide`: http://www.rath.org/s3ql-docs/index.html
.. _`S3QL Wiki`: https://bitbucket.org/nikratio/s3ql/wiki/
- .. _`Installation Instructions`: https://bitbucket.org/nikratio/s3ql/wiki/Installation
.. _`S3QL FAQ`: https://bitbucket.org/nikratio/s3ql/wiki/FAQ
.. _`S3QL Mailing List`: http://groups.google.com/group/s3ql
.. _`GitHub Issue Tracker`: https://github.com/s3ql/s3ql/issues
- .. _BitBucket: https://bitbucket.org/nikratio/s3ql/
.. _GitHub: https://github.com/s3ql/main
.. _`Rath Consulting`: http://www.rath-consulting.biz/
diff --git a/README.rst b/README.rst
index 9f0029d..0cd2e90 100644
--- a/README.rst
+++ b/README.rst
@@ -1,6 +1,6 @@
..
NOTE: We cannot use sophisticated ReST syntax here because this
- file is rendered by Bitbucket.
+ file is rendered by GitHub.
======
S3QL
@@ -140,7 +140,7 @@ Please report any bugs you may encounter in the `GitHub Issue Tracker`_.
Contributing
============
-The S3QL source code is available both on GitHub_ and BitBucket_.
+The S3QL source code is available on GitHub_.
Professional Support
--------------------
@@ -149,10 +149,8 @@ Professional support is offered via `Rath Consulting`_.
.. _`S3QL User's Guide`: http://www.rath.org/s3ql-docs/index.html
.. _`S3QL Wiki`: https://bitbucket.org/nikratio/s3ql/wiki/
-.. _`Installation Instructions`: https://bitbucket.org/nikratio/s3ql/wiki/Installation
.. _`S3QL FAQ`: https://bitbucket.org/nikratio/s3ql/wiki/FAQ
.. _`S3QL Mailing List`: http://groups.google.com/group/s3ql
.. _`GitHub Issue Tracker`: https://github.com/s3ql/s3ql/issues
-.. _BitBucket: https://bitbucket.org/nikratio/s3ql/
.. _GitHub: https://github.com/s3ql/main
.. _`Rath Consulting`: http://www.rath-consulting.biz/
diff --git a/contrib/expire_backups.1 b/contrib/expire_backups.1
index 3e5c333..d99b395 100644
--- a/contrib/expire_backups.1
+++ b/contrib/expire_backups.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "EXPIRE_BACKUPS" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "EXPIRE_BACKUPS" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
expire_backups \- Intelligently expire old backups
.
@@ -177,7 +177,7 @@ Invalid command line argument or configuration file key.
.UNINDENT
.SH SEE ALSO
.sp
-\fBexpire_backups\fP is shipped as part of S3QL, \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+\fBexpire_backups\fP is shipped as part of S3QL, \fI\%https://github.com/s3ql/s3ql/\fP\&.
.SH COPYRIGHT
© 2008 Nikolaus Rath <Nikolaus@rath.org>
.\" Generated by docutils manpage writer.
diff --git a/contrib/pcp.1 b/contrib/pcp.1
index d73312a..046a39b 100644
--- a/contrib/pcp.1
+++ b/contrib/pcp.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "PCP" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "PCP" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
pcp \- Recursive, parallel copy of directory trees
.
@@ -100,7 +100,7 @@ Invalid command line argument or configuration file key.
.UNINDENT
.SH SEE ALSO
.sp
-\fBpcp\fP is shipped as part of S3QL, \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+\fBpcp\fP is shipped as part of S3QL, \fI\%https://github.com/s3ql/s3ql/\fP\&.
.SH COPYRIGHT
© 2008 Nikolaus Rath <Nikolaus@rath.org>
.\" Generated by docutils manpage writer.
diff --git a/doc/latex/Makefile b/doc/latex/Makefile
index d748006..c561680 100644
--- a/doc/latex/Makefile
+++ b/doc/latex/Makefile
@@ -3,33 +3,42 @@
ALLDOCS = $(basename $(wildcard *.tex))
ALLPDF = $(addsuffix .pdf,$(ALLDOCS))
ALLDVI = $(addsuffix .dvi,$(ALLDOCS))
+ALLXDV =
+ALLPS = $(addsuffix .ps,$(ALLDOCS))
+ALLIMGS = $(wildcard *.png *.gif *.jpg *.jpeg)
# Prefix for archive names
-ARCHIVEPRREFIX =
-# Additional LaTeX options
-LATEXOPTS =
-# format: pdf or dvi
+ARCHIVEPREFIX =
+# Additional LaTeX options (passed via variables in latexmkrc/latexmkjarc file)
+export LATEXOPTS =
+# Additional latexmk options
+LATEXMKOPTS =
+# format: pdf or dvi (used only by archive targets)
FMT = pdf
-LATEX = latex
-PDFLATEX = pdflatex
-MAKEINDEX = makeindex
+LATEX = latexmk -dvi
+PDFLATEX = latexmk -pdf -dvi- -ps-
+
+
+%.png %.gif %.jpg %.jpeg: FORCE_MAKE
+ extractbb '$@'
+
+%.dvi: %.tex FORCE_MAKE
+ $(LATEX) $(LATEXMKOPTS) '$<'
+
+%.ps: %.dvi
+ dvips '$<'
+
+%.pdf: %.tex FORCE_MAKE
+ $(PDFLATEX) $(LATEXMKOPTS) '$<'
all: $(ALLPDF)
-all-pdf: $(ALLPDF)
+
all-dvi: $(ALLDVI)
-all-ps: all-dvi
- for f in *.dvi; do dvips $$f; done
-
-all-pdf-ja:
- for f in *.pdf *.png *.gif *.jpg *.jpeg; do extractbb $$f; done
- for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
- for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
- for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
- -for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done
- for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
- for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done
- for f in *.dvi; do dvipdfmx $$f; done
+
+all-ps: $(ALLPS)
+
+all-pdf: $(ALLPDF)
zip: all-$(FMT)
mkdir $(ARCHIVEPREFIX)docs-$(FMT)
@@ -52,27 +61,8 @@ bz2: tar
xz: tar
xz -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar
-# The number of LaTeX runs is quite conservative, but I don't expect it
-# to get run often, so the little extra time won't hurt.
-%.dvi: %.tex
- $(LATEX) $(LATEXOPTS) '$<'
- $(LATEX) $(LATEXOPTS) '$<'
- $(LATEX) $(LATEXOPTS) '$<'
- -$(MAKEINDEX) -s python.ist '$(basename $<).idx'
- $(LATEX) $(LATEXOPTS) '$<'
- $(LATEX) $(LATEXOPTS) '$<'
-
-%.pdf: %.tex
- $(PDFLATEX) $(LATEXOPTS) '$<'
- $(PDFLATEX) $(LATEXOPTS) '$<'
- $(PDFLATEX) $(LATEXOPTS) '$<'
- -$(MAKEINDEX) -s python.ist '$(basename $<).idx'
- $(PDFLATEX) $(LATEXOPTS) '$<'
- $(PDFLATEX) $(LATEXOPTS) '$<'
-
clean:
- rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz $(ALLPDF) $(ALLDVI)
+ rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz $(ALLPDF) $(ALLDVI) $(ALLXDV) *.fls *.fdb_latexmk
.PHONY: all all-pdf all-dvi all-ps clean zip tar gz bz2 xz
-.PHONY: all-pdf-ja
-
+.PHONY: FORCE_MAKE \ No newline at end of file
diff --git a/doc/latex/manual.aux b/doc/latex/manual.aux
index 0c1cafc..f71d0ab 100644
--- a/doc/latex/manual.aux
+++ b/doc/latex/manual.aux
@@ -24,13 +24,10 @@
\@writefile{toc}{\contentsline {chapter}{\numberline {1}S3QL}{1}{chapter.1}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{about::doc}{{1}{1}{S3QL}{chapter.1}{}}
-\newlabel{about:s3ql-user-s-guide}{{1}{1}{S3QL}{chapter.1}{}}
\newlabel{about:s3ql}{{1}{1}{S3QL}{chapter.1}{}}
+\newlabel{about::doc}{{1}{1}{S3QL}{chapter.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.1}Features}{1}{section.1.1}}
\newlabel{about:features}{{1.1}{1}{Features}{section.1.1}{}}
-\newlabel{about:openstack}{{1.1}{1}{Features}{section.1.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.2}Development Status}{2}{section.1.2}}
\newlabel{about:development-status}{{1.2}{2}{Development Status}{section.1.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.3}Supported Platforms}{2}{section.1.3}}
@@ -40,15 +37,13 @@
\@writefile{toc}{\contentsline {chapter}{\numberline {2}Installation}{3}{chapter.2}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{installation:github}{{2}{3}{Installation}{chapter.2}{}}
-\newlabel{installation::doc}{{2}{3}{Installation}{chapter.2}{}}
\newlabel{installation:installation}{{2}{3}{Installation}{chapter.2}{}}
+\newlabel{installation::doc}{{2}{3}{Installation}{chapter.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.1}Dependencies}{3}{section.2.1}}
\newlabel{installation:dependencies}{{2.1}{3}{Dependencies}{section.2.1}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {2.2}Installing S3QL}{4}{section.2.2}}
-\newlabel{installation:installing-s3ql}{{2.2}{4}{Installing S3QL}{section.2.2}{}}
-\newlabel{installation:inst-s3ql}{{2.2}{4}{Installing S3QL}{section.2.2}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {2.2}Installing S3QL}{3}{section.2.2}}
+\newlabel{installation:installing-s3ql}{{2.2}{3}{Installing S3QL}{section.2.2}{}}
+\newlabel{installation:inst-s3ql}{{2.2}{3}{Installing S3QL}{section.2.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.3}Development Version}{4}{section.2.3}}
\newlabel{installation:development-version}{{2.3}{4}{Development Version}{section.2.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.4}Running tests requiring remote servers}{4}{section.2.4}}
@@ -56,54 +51,47 @@
\@writefile{toc}{\contentsline {chapter}{\numberline {3}Storage Backends}{7}{chapter.3}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{backends:sphinx}{{3}{7}{Storage Backends}{chapter.3}{}}
-\newlabel{backends::doc}{{3}{7}{Storage Backends}{chapter.3}{}}
\newlabel{backends:storage-backends}{{3}{7}{Storage Backends}{chapter.3}{}}
\newlabel{backends:id1}{{3}{7}{Storage Backends}{chapter.3}{}}
+\newlabel{backends::doc}{{3}{7}{Storage Backends}{chapter.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.1}Google Storage}{7}{section.3.1}}
\newlabel{backends:google-storage}{{3.1}{7}{Google Storage}{section.3.1}{}}
-\newlabel{backends:cmdoption-gs_backend-arg-no-ssl}{{3.1}{7}{Google Storage}{section*.3}{}}
-\newlabel{backends:cmdoption-gs_backend-arg-ssl-ca-path}{{3.1}{8}{Google Storage}{section*.4}{}}
-\newlabel{backends:cmdoption-gs_backend-arg-tcp-timeout}{{3.1}{8}{Google Storage}{section*.5}{}}
+\newlabel{backends:cmdoption-gs-backend-arg-no-ssl}{{3.1}{7}{Google Storage}{section*.3}{}}
+\newlabel{backends:cmdoption-gs-backend-arg-ssl-ca-path}{{3.1}{8}{Google Storage}{section*.4}{}}
+\newlabel{backends:cmdoption-gs-backend-arg-tcp-timeout}{{3.1}{8}{Google Storage}{section*.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.2}Amazon S3}{8}{section.3.2}}
\newlabel{backends:amazon-s3}{{3.2}{8}{Amazon S3}{section.3.2}{}}
-\newlabel{backends:google-storage-manager}{{3.2}{8}{Amazon S3}{section.3.2}{}}
-\newlabel{backends:cmdoption-s3_backend-arg-no-ssl}{{3.2}{8}{Amazon S3}{section*.6}{}}
-\newlabel{backends:cmdoption-s3_backend-arg-ssl-ca-path}{{3.2}{8}{Amazon S3}{section*.7}{}}
-\newlabel{backends:cmdoption-s3_backend-arg-tcp-timeout}{{3.2}{8}{Amazon S3}{section*.8}{}}
-\newlabel{backends:cmdoption-s3_backend-arg-sse}{{3.2}{8}{Amazon S3}{section*.9}{}}
-\newlabel{backends:cmdoption-s3_backend-arg-ia}{{3.2}{8}{Amazon S3}{section*.10}{}}
-\newlabel{backends:cmdoption-s3_backend-arg-rrs}{{3.2}{8}{Amazon S3}{section*.11}{}}
+\newlabel{backends:cmdoption-s3-backend-arg-no-ssl}{{3.2}{8}{Amazon S3}{section*.6}{}}
+\newlabel{backends:cmdoption-s3-backend-arg-ssl-ca-path}{{3.2}{8}{Amazon S3}{section*.7}{}}
+\newlabel{backends:cmdoption-s3-backend-arg-tcp-timeout}{{3.2}{8}{Amazon S3}{section*.8}{}}
+\newlabel{backends:cmdoption-s3-backend-arg-sse}{{3.2}{8}{Amazon S3}{section*.9}{}}
+\newlabel{backends:cmdoption-s3-backend-arg-ia}{{3.2}{8}{Amazon S3}{section*.10}{}}
+\newlabel{backends:cmdoption-s3-backend-arg-rrs}{{3.2}{8}{Amazon S3}{section*.11}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.3}OpenStack/Swift}{9}{section.3.3}}
\newlabel{backends:openstack-swift}{{3.3}{9}{OpenStack/Swift}{section.3.3}{}}
\newlabel{backends:openstack-backend}{{3.3}{9}{OpenStack/Swift}{section.3.3}{}}
-\newlabel{backends:cmdoption-swift_backend-arg-no-ssl}{{3.3}{9}{OpenStack/Swift}{section*.12}{}}
-\newlabel{backends:cmdoption-swift_backend-arg-ssl-ca-path}{{3.3}{9}{OpenStack/Swift}{section*.13}{}}
-\newlabel{backends:cmdoption-swift_backend-arg-tcp-timeout}{{3.3}{9}{OpenStack/Swift}{section*.14}{}}
-\newlabel{backends:cmdoption-swift_backend-arg-disable-expect100}{{3.3}{9}{OpenStack/Swift}{section*.15}{}}
-\newlabel{backends:cmdoption-swift_backend-arg-no-feature-detection}{{3.3}{9}{OpenStack/Swift}{section*.16}{}}
+\newlabel{backends:cmdoption-swift-backend-arg-no-ssl}{{3.3}{9}{OpenStack/Swift}{section*.12}{}}
+\newlabel{backends:cmdoption-swift-backend-arg-ssl-ca-path}{{3.3}{9}{OpenStack/Swift}{section*.13}{}}
+\newlabel{backends:cmdoption-swift-backend-arg-tcp-timeout}{{3.3}{9}{OpenStack/Swift}{section*.14}{}}
+\newlabel{backends:cmdoption-swift-backend-arg-disable-expect100}{{3.3}{9}{OpenStack/Swift}{section*.15}{}}
+\newlabel{backends:cmdoption-swift-backend-arg-no-feature-detection}{{3.3}{9}{OpenStack/Swift}{section*.16}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.4}Rackspace CloudFiles}{10}{section.3.4}}
\newlabel{backends:rackspace-cloudfiles}{{3.4}{10}{Rackspace CloudFiles}{section.3.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.5}S3 compatible}{10}{section.3.5}}
\newlabel{backends:s3-compatible}{{3.5}{10}{S3 compatible}{section.3.5}{}}
-\newlabel{backends:rackspace}{{3.5}{10}{S3 compatible}{section.3.5}{}}
-\newlabel{backends:cmdoption-s3c_backend-arg-no-ssl}{{3.5}{10}{S3 compatible}{section*.17}{}}
-\newlabel{backends:cmdoption-s3c_backend-arg-ssl-ca-path}{{3.5}{10}{S3 compatible}{section*.18}{}}
-\newlabel{backends:cmdoption-s3c_backend-arg-tcp-timeout}{{3.5}{10}{S3 compatible}{section*.19}{}}
-\newlabel{backends:cmdoption-s3c_backend-arg-disable-expect100}{{3.5}{10}{S3 compatible}{section*.20}{}}
-\newlabel{backends:cmdoption-s3c_backend-arg-dumb-copy}{{3.5}{10}{S3 compatible}{section*.21}{}}
+\newlabel{backends:cmdoption-s3c-backend-arg-no-ssl}{{3.5}{10}{S3 compatible}{section*.17}{}}
+\newlabel{backends:cmdoption-s3c-backend-arg-ssl-ca-path}{{3.5}{10}{S3 compatible}{section*.18}{}}
+\newlabel{backends:cmdoption-s3c-backend-arg-tcp-timeout}{{3.5}{10}{S3 compatible}{section*.19}{}}
+\newlabel{backends:cmdoption-s3c-backend-arg-disable-expect100}{{3.5}{10}{S3 compatible}{section*.20}{}}
+\newlabel{backends:cmdoption-s3c-backend-arg-dumb-copy}{{3.5}{10}{S3 compatible}{section*.21}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.6}Local}{11}{section.3.6}}
-\newlabel{backends:id6}{{3.6}{11}{Local}{section.3.6}{}}
\newlabel{backends:local}{{3.6}{11}{Local}{section.3.6}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {4}Important Rules to Avoid Losing Data}{13}{chapter.4}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{durability::doc}{{4}{13}{Important Rules to Avoid Losing Data}{chapter.4}{}}
-\newlabel{durability:sshfs}{{4}{13}{Important Rules to Avoid Losing Data}{chapter.4}{}}
-\newlabel{durability:durability}{{4}{13}{Important Rules to Avoid Losing Data}{chapter.4}{}}
\newlabel{durability:important-rules-to-avoid-losing-data}{{4}{13}{Important Rules to Avoid Losing Data}{chapter.4}{}}
+\newlabel{durability:durability}{{4}{13}{Important Rules to Avoid Losing Data}{chapter.4}{}}
+\newlabel{durability::doc}{{4}{13}{Important Rules to Avoid Losing Data}{chapter.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.1}Rules in a Nutshell}{13}{section.4.1}}
\newlabel{durability:rules-in-a-nutshell}{{4.1}{13}{Rules in a Nutshell}{section.4.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.2}Consistency Window List}{14}{section.4.2}}
@@ -111,20 +99,18 @@
\@writefile{toc}{\contentsline {section}{\numberline {4.3}Data Consistency}{14}{section.4.3}}
\newlabel{durability:data-consistency}{{4.3}{14}{Data Consistency}{section.4.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.4}Data Durability}{15}{section.4.4}}
-\newlabel{durability:backend-reliability}{{4.4}{15}{Data Durability}{section.4.4}{}}
\newlabel{durability:data-durability}{{4.4}{15}{Data Durability}{section.4.4}{}}
+\newlabel{durability:backend-reliability}{{4.4}{15}{Data Durability}{section.4.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {5}File System Creation}{17}{chapter.5}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
\newlabel{mkfs:file-system-creation}{{5}{17}{File System Creation}{chapter.5}{}}
\newlabel{mkfs::doc}{{5}{17}{File System Creation}{chapter.5}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {6}Managing File Systems}{19}{chapter.6}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{adm::doc}{{6}{19}{Managing File Systems}{chapter.6}{}}
\newlabel{adm:managing-file-systems}{{6}{19}{Managing File Systems}{chapter.6}{}}
+\newlabel{adm::doc}{{6}{19}{Managing File Systems}{chapter.6}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.1}Changing the Passphrase}{19}{section.6.1}}
\newlabel{adm:changing-the-passphrase}{{6.1}{19}{Changing the Passphrase}{section.6.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.2}Upgrading the file system}{20}{section.6.2}}
@@ -136,9 +122,8 @@
\@writefile{toc}{\contentsline {chapter}{\numberline {7}Mounting}{21}{chapter.7}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{mount::doc}{{7}{21}{Mounting}{chapter.7}{}}
\newlabel{mount:mounting}{{7}{21}{Mounting}{chapter.7}{}}
+\newlabel{mount::doc}{{7}{21}{Mounting}{chapter.7}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.1}Permission Checking}{22}{section.7.1}}
\newlabel{mount:permission-checking}{{7.1}{22}{Permission Checking}{section.7.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.2}Compression Algorithms}{22}{section.7.2}}
@@ -155,11 +140,9 @@
\newlabel{mount:failure-modes}{{7.5}{23}{Failure Modes}{section.7.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.6}Automatic Mounting}{24}{section.7.6}}
\newlabel{mount:automatic-mounting}{{7.6}{24}{Automatic Mounting}{section.7.6}{}}
-\newlabel{mount:logcheck}{{7.6}{24}{Automatic Mounting}{section.7.6}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {8}Advanced S3QL Features}{25}{chapter.8}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
\newlabel{special:advanced-s3ql-features}{{8}{25}{Advanced S3QL Features}{chapter.8}{}}
\newlabel{special::doc}{{8}{25}{Advanced S3QL Features}{chapter.8}{}}
\@writefile{toc}{\contentsline {section}{\numberline {8.1}Snapshotting and Copy-on-Write}{25}{section.8.1}}
@@ -171,8 +154,8 @@
\newlabel{special:getting-statistics}{{8.2}{26}{Getting Statistics}{section.8.2}{}}
\newlabel{special:s3qlstat}{{8.2}{26}{Getting Statistics}{section.8.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {8.3}Immutable Trees}{26}{section.8.3}}
-\newlabel{special:s3qllock}{{8.3}{26}{Immutable Trees}{section.8.3}{}}
\newlabel{special:immutable-trees}{{8.3}{26}{Immutable Trees}{section.8.3}{}}
+\newlabel{special:s3qllock}{{8.3}{26}{Immutable Trees}{section.8.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {8.4}Fast Recursive Removal}{27}{section.8.4}}
\newlabel{special:fast-recursive-removal}{{8.4}{27}{Fast Recursive Removal}{section.8.4}{}}
\newlabel{special:s3qlrm}{{8.4}{27}{Fast Recursive Removal}{section.8.4}{}}
@@ -182,15 +165,13 @@
\@writefile{toc}{\contentsline {chapter}{\numberline {9}Unmounting}{29}{chapter.9}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{umount::doc}{{9}{29}{Unmounting}{chapter.9}{}}
\newlabel{umount:unmounting}{{9}{29}{Unmounting}{chapter.9}{}}
+\newlabel{umount::doc}{{9}{29}{Unmounting}{chapter.9}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {10}Checking for Errors}{31}{chapter.10}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{fsck::doc}{{10}{31}{Checking for Errors}{chapter.10}{}}
\newlabel{fsck:checking-for-errors}{{10}{31}{Checking for Errors}{chapter.10}{}}
+\newlabel{fsck::doc}{{10}{31}{Checking for Errors}{chapter.10}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.1}Checking and repairing internal file system errors}{31}{section.10.1}}
\newlabel{fsck:checking-and-repairing-internal-file-system-errors}{{10.1}{31}{Checking and repairing internal file system errors}{section.10.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.2}Detecting and handling backend data corruption}{32}{section.10.2}}
@@ -199,16 +180,14 @@
\@writefile{toc}{\contentsline {chapter}{\numberline {11}Storing Backend Information}{35}{chapter.11}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
+\newlabel{authinfo:storing-backend-information}{{11}{35}{Storing Backend Information}{chapter.11}{}}
\newlabel{authinfo:authinfo}{{11}{35}{Storing Backend Information}{chapter.11}{}}
\newlabel{authinfo::doc}{{11}{35}{Storing Backend Information}{chapter.11}{}}
-\newlabel{authinfo:storing-backend-information}{{11}{35}{Storing Backend Information}{chapter.11}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {12}Contributed Programs}{37}{chapter.12}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{contrib::doc}{{12}{37}{Contributed Programs}{chapter.12}{}}
\newlabel{contrib:contributed-programs}{{12}{37}{Contributed Programs}{chapter.12}{}}
+\newlabel{contrib::doc}{{12}{37}{Contributed Programs}{chapter.12}{}}
\@writefile{toc}{\contentsline {section}{\numberline {12.1}benchmark.py}{37}{section.12.1}}
\newlabel{contrib:benchmark-py}{{12.1}{37}{benchmark.py}{section.12.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {12.2}clone\_fs.py}{37}{section.12.2}}
@@ -226,241 +205,269 @@
\@writefile{toc}{\contentsline {chapter}{\numberline {13}Tips \& Tricks}{41}{chapter.13}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{tips::doc}{{13}{41}{Tips \& Tricks}{chapter.13}{}}
\newlabel{tips:tips-tricks}{{13}{41}{Tips \& Tricks}{chapter.13}{}}
+\newlabel{tips::doc}{{13}{41}{Tips \& Tricks}{chapter.13}{}}
\@writefile{toc}{\contentsline {section}{\numberline {13.1}SSH Backend}{41}{section.13.1}}
\newlabel{tips:ssh-backend}{{13.1}{41}{SSH Backend}{section.13.1}{}}
\newlabel{tips:ssh-tipp}{{13.1}{41}{SSH Backend}{section.13.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {13.2}Permanently mounted backup file system}{41}{section.13.2}}
\newlabel{tips:permanently-mounted-backup-file-system}{{13.2}{41}{Permanently mounted backup file system}{section.13.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {13.3}Improving copy performance}{41}{section.13.3}}
-\newlabel{tips:copy-performance}{{13.3}{41}{Improving copy performance}{section.13.3}{}}
\newlabel{tips:improving-copy-performance}{{13.3}{41}{Improving copy performance}{section.13.3}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {14}Known Issues}{43}{chapter.14}}
+\newlabel{tips:copy-performance}{{13.3}{41}{Improving copy performance}{section.13.3}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {14}Frequently Asked Questions}{43}{chapter.14}}
+\@writefile{lof}{\addvspace {10\p@ }}
+\@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{faq:frequently-asked-questions}{{14}{43}{Frequently Asked Questions}{chapter.14}{}}
+\newlabel{faq::doc}{{14}{43}{Frequently Asked Questions}{chapter.14}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.1}What does \IeC {\textquotedblleft }python-apsw must be linked dynamically to sqlite3\IeC {\textquotedblright } mean?}{43}{section.14.1}}
+\newlabel{faq:what-does-python-apsw-must-be-linked-dynamically-to-sqlite3-mean}{{14.1}{43}{What does “python-apsw must be linked dynamically to sqlite3” mean?}{section.14.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.2}How can I improve the file system throughput?}{43}{section.14.2}}
+\newlabel{faq:how-can-i-improve-the-file-system-throughput}{{14.2}{43}{How can I improve the file system throughput?}{section.14.2}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.3}Why does \sphinxstyleliteralintitle {\sphinxupquote {df}} show 1 TB of free space?}{43}{section.14.3}}
+\newlabel{faq:why-does-df-show-1-tb-of-free-space}{{14.3}{43}{Why does \sphinxstyleliteralintitle {\sphinxupquote {df}} show 1 TB of free space?}{section.14.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.4}Which operating systems are supported?}{44}{section.14.4}}
+\newlabel{faq:which-operating-systems-are-supported}{{14.4}{44}{Which operating systems are supported?}{section.14.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.5}Is there a file size limit?}{44}{section.14.5}}
+\newlabel{faq:is-there-a-file-size-limit}{{14.5}{44}{Is there a file size limit?}{section.14.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.6}Suppose I want to make a small change in a very large file. Will S3QL download and re-upload the entire file?}{44}{section.14.6}}
+\newlabel{faq:suppose-i-want-to-make-a-small-change-in-a-very-large-file-will-s3ql-download-and-re-upload-the-entire-file}{{14.6}{44}{Suppose I want to make a small change in a very large file. Will S3QL download and re-upload the entire file?}{section.14.6}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.7}I don\IeC {\textquoteright }t quite understand this de-duplication feature\IeC {\textellipsis }}{44}{section.14.7}}
+\newlabel{faq:i-don-t-quite-understand-this-de-duplication-feature}{{14.7}{44}{I don’t quite understand this de-duplication feature…}{section.14.7}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.8}What does the \IeC {\textquotedblleft }Transport endpoint not connected\IeC {\textquotedblright } error mean?}{44}{section.14.8}}
+\newlabel{faq:what-does-the-transport-endpoint-not-connected-error-mean}{{14.8}{44}{What does the “Transport endpoint not connected” error mean?}{section.14.8}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.9}What does \IeC {\textquotedblleft }Backend reports that fs is still mounted elsewhere, aborting\IeC {\textquotedblright } mean?}{44}{section.14.9}}
+\newlabel{faq:what-does-backend-reports-that-fs-is-still-mounted-elsewhere-aborting-mean}{{14.9}{44}{What does “Backend reports that fs is still mounted elsewhere, aborting” mean?}{section.14.9}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.10}Can I access an S3QL file system on multiple computers simultaneously?}{45}{section.14.10}}
+\newlabel{faq:can-i-access-an-s3ql-file-system-on-multiple-computers-simultaneously}{{14.10}{45}{Can I access an S3QL file system on multiple computers simultaneously?}{section.14.10}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.11}What maximum object size should I use?}{45}{section.14.11}}
+\newlabel{faq:what-maximum-object-size-should-i-use}{{14.11}{45}{What maximum object size should I use?}{section.14.11}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.12}Is there a way to make the cache persistent / access the file system offline?}{46}{section.14.12}}
+\newlabel{faq:is-there-a-way-to-make-the-cache-persistent-access-the-file-system-offline}{{14.12}{46}{Is there a way to make the cache persistent / access the file system offline?}{section.14.12}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.13}I would like to use S3QL with Hubic, but\IeC {\textellipsis }}{46}{section.14.13}}
+\newlabel{faq:i-would-like-to-use-s3ql-with-hubic-but}{{14.13}{46}{I would like to use S3QL with Hubic, but…}{section.14.13}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {14.14}What\IeC {\textquoteright }s a reasonable metadata upload interval?}{46}{section.14.14}}
+\newlabel{faq:what-s-a-reasonable-metadata-upload-interval}{{14.14}{46}{What’s a reasonable metadata upload interval?}{section.14.14}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {15}Known Issues}{49}{chapter.15}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{issues:known-issues}{{14}{43}{Known Issues}{chapter.14}{}}
-\newlabel{issues::doc}{{14}{43}{Known Issues}{chapter.14}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {15}Manpages}{45}{chapter.15}}
+\newlabel{issues:known-issues}{{15}{49}{Known Issues}{chapter.15}{}}
+\newlabel{issues::doc}{{15}{49}{Known Issues}{chapter.15}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {16}Manpages}{51}{chapter.16}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{man/index::doc}{{15}{45}{Manpages}{chapter.15}{}}
-\newlabel{man/index:manpages}{{15}{45}{Manpages}{chapter.15}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.1}The \textbf {\texttt {mkfs.s3ql}} command}{45}{section.15.1}}
-\newlabel{man/mkfs::doc}{{15.1}{45}{The \textbf {\texttt {mkfs.s3ql}} command}{section.15.1}{}}
-\newlabel{man/mkfs:the-command-command}{{15.1}{45}{The \textbf {\texttt {mkfs.s3ql}} command}{section.15.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.1.1}Synopsis}{45}{subsection.15.1.1}}
-\newlabel{man/mkfs:synopsis}{{15.1.1}{45}{Synopsis}{subsection.15.1.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.1.2}Description}{45}{subsection.15.1.2}}
-\newlabel{man/mkfs:description}{{15.1.2}{45}{Description}{subsection.15.1.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.1.3}Options}{45}{subsection.15.1.3}}
-\newlabel{man/mkfs:options}{{15.1.3}{45}{Options}{subsection.15.1.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.1.4}Exit Codes}{46}{subsection.15.1.4}}
-\newlabel{man/mkfs:exit-codes}{{15.1.4}{46}{Exit Codes}{subsection.15.1.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.1.5}See Also}{46}{subsection.15.1.5}}
-\newlabel{man/mkfs:see-also}{{15.1.5}{46}{See Also}{subsection.15.1.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.2}The \textbf {\texttt {s3qladm}} command}{46}{section.15.2}}
-\newlabel{man/adm::doc}{{15.2}{46}{The \textbf {\texttt {s3qladm}} command}{section.15.2}{}}
-\newlabel{man/adm:the-command-command}{{15.2}{46}{The \textbf {\texttt {s3qladm}} command}{section.15.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.2.1}Synopsis}{46}{subsection.15.2.1}}
-\newlabel{man/adm:synopsis}{{15.2.1}{46}{Synopsis}{subsection.15.2.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.2.2}Description}{47}{subsection.15.2.2}}
-\newlabel{man/adm:description}{{15.2.2}{47}{Description}{subsection.15.2.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.2.3}Options}{47}{subsection.15.2.3}}
-\newlabel{man/adm:options}{{15.2.3}{47}{Options}{subsection.15.2.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.2.4}Actions}{47}{subsection.15.2.4}}
-\newlabel{man/adm:actions}{{15.2.4}{47}{Actions}{subsection.15.2.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.2.5}Exit Codes}{47}{subsection.15.2.5}}
-\newlabel{man/adm:exit-codes}{{15.2.5}{47}{Exit Codes}{subsection.15.2.5}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.2.6}See Also}{48}{subsection.15.2.6}}
-\newlabel{man/adm:see-also}{{15.2.6}{48}{See Also}{subsection.15.2.6}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.3}The \textbf {\texttt {mount.s3ql}} command}{48}{section.15.3}}
-\newlabel{man/mount::doc}{{15.3}{48}{The \textbf {\texttt {mount.s3ql}} command}{section.15.3}{}}
-\newlabel{man/mount:the-command-command}{{15.3}{48}{The \textbf {\texttt {mount.s3ql}} command}{section.15.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.3.1}Synopsis}{48}{subsection.15.3.1}}
-\newlabel{man/mount:synopsis}{{15.3.1}{48}{Synopsis}{subsection.15.3.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.3.2}Description}{48}{subsection.15.3.2}}
-\newlabel{man/mount:description}{{15.3.2}{48}{Description}{subsection.15.3.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.3.3}Options}{48}{subsection.15.3.3}}
-\newlabel{man/mount:options}{{15.3.3}{48}{Options}{subsection.15.3.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.3.4}Exit Codes}{49}{subsection.15.3.4}}
-\newlabel{man/mount:exit-codes}{{15.3.4}{49}{Exit Codes}{subsection.15.3.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.3.5}See Also}{50}{subsection.15.3.5}}
-\newlabel{man/mount:see-also}{{15.3.5}{50}{See Also}{subsection.15.3.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.4}The \textbf {\texttt {s3qlstat}} command}{50}{section.15.4}}
-\newlabel{man/stat::doc}{{15.4}{50}{The \textbf {\texttt {s3qlstat}} command}{section.15.4}{}}
-\newlabel{man/stat:the-command-command}{{15.4}{50}{The \textbf {\texttt {s3qlstat}} command}{section.15.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.4.1}Synopsis}{50}{subsection.15.4.1}}
-\newlabel{man/stat:synopsis}{{15.4.1}{50}{Synopsis}{subsection.15.4.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.4.2}Description}{50}{subsection.15.4.2}}
-\newlabel{man/stat:description}{{15.4.2}{50}{Description}{subsection.15.4.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.4.3}Options}{51}{subsection.15.4.3}}
-\newlabel{man/stat:options}{{15.4.3}{51}{Options}{subsection.15.4.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.4.4}Exit Codes}{51}{subsection.15.4.4}}
-\newlabel{man/stat:exit-codes}{{15.4.4}{51}{Exit Codes}{subsection.15.4.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.4.5}See Also}{51}{subsection.15.4.5}}
-\newlabel{man/stat:see-also}{{15.4.5}{51}{See Also}{subsection.15.4.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.5}The \textbf {\texttt {s3qlctrl}} command}{51}{section.15.5}}
-\newlabel{man/ctrl::doc}{{15.5}{51}{The \textbf {\texttt {s3qlctrl}} command}{section.15.5}{}}
-\newlabel{man/ctrl:the-command-command}{{15.5}{51}{The \textbf {\texttt {s3qlctrl}} command}{section.15.5}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.5.1}Synopsis}{51}{subsection.15.5.1}}
-\newlabel{man/ctrl:synopsis}{{15.5.1}{51}{Synopsis}{subsection.15.5.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.5.2}Description}{51}{subsection.15.5.2}}
-\newlabel{man/ctrl:description}{{15.5.2}{51}{Description}{subsection.15.5.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.5.3}Options}{52}{subsection.15.5.3}}
-\newlabel{man/ctrl:options}{{15.5.3}{52}{Options}{subsection.15.5.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.5.4}Exit Codes}{52}{subsection.15.5.4}}
-\newlabel{man/ctrl:exit-codes}{{15.5.4}{52}{Exit Codes}{subsection.15.5.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.5.5}See Also}{52}{subsection.15.5.5}}
-\newlabel{man/ctrl:see-also}{{15.5.5}{52}{See Also}{subsection.15.5.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.6}The \textbf {\texttt {s3qlcp}} command}{52}{section.15.6}}
-\newlabel{man/cp::doc}{{15.6}{52}{The \textbf {\texttt {s3qlcp}} command}{section.15.6}{}}
-\newlabel{man/cp:the-command-command}{{15.6}{52}{The \textbf {\texttt {s3qlcp}} command}{section.15.6}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.6.1}Synopsis}{52}{subsection.15.6.1}}
-\newlabel{man/cp:synopsis}{{15.6.1}{52}{Synopsis}{subsection.15.6.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.6.2}Description}{53}{subsection.15.6.2}}
-\newlabel{man/cp:description}{{15.6.2}{53}{Description}{subsection.15.6.2}{}}
-\@writefile{toc}{\contentsline {subsubsection}{Snapshotting vs Hardlinking}{53}{subsubsection*.22}}
-\newlabel{man/cp:snapshotting-vs-hardlinking}{{15.6.2}{53}{Snapshotting vs Hardlinking}{subsubsection*.22}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.6.3}Options}{53}{subsection.15.6.3}}
-\newlabel{man/cp:options}{{15.6.3}{53}{Options}{subsection.15.6.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.6.4}Exit Codes}{53}{subsection.15.6.4}}
-\newlabel{man/cp:exit-codes}{{15.6.4}{53}{Exit Codes}{subsection.15.6.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.6.5}See Also}{54}{subsection.15.6.5}}
-\newlabel{man/cp:see-also}{{15.6.5}{54}{See Also}{subsection.15.6.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.7}The \textbf {\texttt {s3qlrm}} command}{54}{section.15.7}}
-\newlabel{man/rm::doc}{{15.7}{54}{The \textbf {\texttt {s3qlrm}} command}{section.15.7}{}}
-\newlabel{man/rm:the-command-command}{{15.7}{54}{The \textbf {\texttt {s3qlrm}} command}{section.15.7}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.7.1}Synopsis}{54}{subsection.15.7.1}}
-\newlabel{man/rm:synopsis}{{15.7.1}{54}{Synopsis}{subsection.15.7.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.7.2}Description}{54}{subsection.15.7.2}}
-\newlabel{man/rm:description}{{15.7.2}{54}{Description}{subsection.15.7.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.7.3}Options}{54}{subsection.15.7.3}}
-\newlabel{man/rm:options}{{15.7.3}{54}{Options}{subsection.15.7.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.7.4}Exit Codes}{54}{subsection.15.7.4}}
-\newlabel{man/rm:exit-codes}{{15.7.4}{54}{Exit Codes}{subsection.15.7.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.7.5}See Also}{55}{subsection.15.7.5}}
-\newlabel{man/rm:see-also}{{15.7.5}{55}{See Also}{subsection.15.7.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.8}The \textbf {\texttt {s3qllock}} command}{55}{section.15.8}}
-\newlabel{man/lock::doc}{{15.8}{55}{The \textbf {\texttt {s3qllock}} command}{section.15.8}{}}
-\newlabel{man/lock:the-command-command}{{15.8}{55}{The \textbf {\texttt {s3qllock}} command}{section.15.8}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.8.1}Synopsis}{55}{subsection.15.8.1}}
-\newlabel{man/lock:synopsis}{{15.8.1}{55}{Synopsis}{subsection.15.8.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.8.2}Description}{55}{subsection.15.8.2}}
-\newlabel{man/lock:description}{{15.8.2}{55}{Description}{subsection.15.8.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.8.3}Rationale}{55}{subsection.15.8.3}}
-\newlabel{man/lock:rationale}{{15.8.3}{55}{Rationale}{subsection.15.8.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.8.4}Options}{55}{subsection.15.8.4}}
-\newlabel{man/lock:options}{{15.8.4}{55}{Options}{subsection.15.8.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.8.5}Exit Codes}{56}{subsection.15.8.5}}
-\newlabel{man/lock:exit-codes}{{15.8.5}{56}{Exit Codes}{subsection.15.8.5}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.8.6}See Also}{56}{subsection.15.8.6}}
-\newlabel{man/lock:see-also}{{15.8.6}{56}{See Also}{subsection.15.8.6}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.9}The \textbf {\texttt {umount.s3ql}} command}{56}{section.15.9}}
-\newlabel{man/umount::doc}{{15.9}{56}{The \textbf {\texttt {umount.s3ql}} command}{section.15.9}{}}
-\newlabel{man/umount:the-command-command}{{15.9}{56}{The \textbf {\texttt {umount.s3ql}} command}{section.15.9}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.9.1}Synopsis}{56}{subsection.15.9.1}}
-\newlabel{man/umount:synopsis}{{15.9.1}{56}{Synopsis}{subsection.15.9.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.9.2}Description}{56}{subsection.15.9.2}}
-\newlabel{man/umount:description}{{15.9.2}{56}{Description}{subsection.15.9.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.9.3}Options}{56}{subsection.15.9.3}}
-\newlabel{man/umount:options}{{15.9.3}{56}{Options}{subsection.15.9.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.9.4}Exit Codes}{57}{subsection.15.9.4}}
-\newlabel{man/umount:exit-codes}{{15.9.4}{57}{Exit Codes}{subsection.15.9.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.9.5}See Also}{57}{subsection.15.9.5}}
-\newlabel{man/umount:see-also}{{15.9.5}{57}{See Also}{subsection.15.9.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.10}The \textbf {\texttt {fsck.s3ql}} command}{57}{section.15.10}}
-\newlabel{man/fsck::doc}{{15.10}{57}{The \textbf {\texttt {fsck.s3ql}} command}{section.15.10}{}}
-\newlabel{man/fsck:the-command-command}{{15.10}{57}{The \textbf {\texttt {fsck.s3ql}} command}{section.15.10}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.10.1}Synopsis}{57}{subsection.15.10.1}}
-\newlabel{man/fsck:synopsis}{{15.10.1}{57}{Synopsis}{subsection.15.10.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.10.2}Description}{57}{subsection.15.10.2}}
-\newlabel{man/fsck:description}{{15.10.2}{57}{Description}{subsection.15.10.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.10.3}Options}{57}{subsection.15.10.3}}
-\newlabel{man/fsck:options}{{15.10.3}{57}{Options}{subsection.15.10.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.10.4}Exit Codes}{58}{subsection.15.10.4}}
-\newlabel{man/fsck:exit-codes}{{15.10.4}{58}{Exit Codes}{subsection.15.10.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.10.5}See Also}{59}{subsection.15.10.5}}
-\newlabel{man/fsck:see-also}{{15.10.5}{59}{See Also}{subsection.15.10.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.11}The \textbf {\texttt {s3ql\_oauth\_client}} command}{59}{section.15.11}}
-\newlabel{man/oauth_client:oauth-client}{{15.11}{59}{The \textbf {\texttt {s3ql\_oauth\_client}} command}{section.15.11}{}}
-\newlabel{man/oauth_client::doc}{{15.11}{59}{The \textbf {\texttt {s3ql\_oauth\_client}} command}{section.15.11}{}}
-\newlabel{man/oauth_client:the-command-command}{{15.11}{59}{The \textbf {\texttt {s3ql\_oauth\_client}} command}{section.15.11}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.11.1}Synopsis}{59}{subsection.15.11.1}}
-\newlabel{man/oauth_client:synopsis}{{15.11.1}{59}{Synopsis}{subsection.15.11.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.11.2}Description}{59}{subsection.15.11.2}}
-\newlabel{man/oauth_client:description}{{15.11.2}{59}{Description}{subsection.15.11.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.11.3}Options}{59}{subsection.15.11.3}}
-\newlabel{man/oauth_client:options}{{15.11.3}{59}{Options}{subsection.15.11.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.11.4}Exit Codes}{59}{subsection.15.11.4}}
-\newlabel{man/oauth_client:exit-codes}{{15.11.4}{59}{Exit Codes}{subsection.15.11.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.11.5}See Also}{60}{subsection.15.11.5}}
-\newlabel{man/oauth_client:see-also}{{15.11.5}{60}{See Also}{subsection.15.11.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.12}The \textbf {\texttt {s3ql\_verify}} command}{60}{section.15.12}}
-\newlabel{man/verify::doc}{{15.12}{60}{The \textbf {\texttt {s3ql\_verify}} command}{section.15.12}{}}
-\newlabel{man/verify:the-command-command}{{15.12}{60}{The \textbf {\texttt {s3ql\_verify}} command}{section.15.12}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.12.1}Synopsis}{60}{subsection.15.12.1}}
-\newlabel{man/verify:synopsis}{{15.12.1}{60}{Synopsis}{subsection.15.12.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.12.2}Description}{60}{subsection.15.12.2}}
-\newlabel{man/verify:description}{{15.12.2}{60}{Description}{subsection.15.12.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.12.3}Options}{60}{subsection.15.12.3}}
-\newlabel{man/verify:options}{{15.12.3}{60}{Options}{subsection.15.12.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.12.4}Exit Codes}{61}{subsection.15.12.4}}
-\newlabel{man/verify:exit-codes}{{15.12.4}{61}{Exit Codes}{subsection.15.12.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.12.5}See Also}{61}{subsection.15.12.5}}
-\newlabel{man/verify:see-also}{{15.12.5}{61}{See Also}{subsection.15.12.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.13}The \textbf {\texttt {pcp}} command}{61}{section.15.13}}
-\newlabel{man/pcp::doc}{{15.13}{61}{The \textbf {\texttt {pcp}} command}{section.15.13}{}}
-\newlabel{man/pcp:the-command-command}{{15.13}{61}{The \textbf {\texttt {pcp}} command}{section.15.13}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.13.1}Synopsis}{61}{subsection.15.13.1}}
-\newlabel{man/pcp:synopsis}{{15.13.1}{61}{Synopsis}{subsection.15.13.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.13.2}Description}{61}{subsection.15.13.2}}
-\newlabel{man/pcp:description}{{15.13.2}{61}{Description}{subsection.15.13.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.13.3}Options}{62}{subsection.15.13.3}}
-\newlabel{man/pcp:options}{{15.13.3}{62}{Options}{subsection.15.13.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.13.4}Exit Codes}{62}{subsection.15.13.4}}
-\newlabel{man/pcp:exit-codes}{{15.13.4}{62}{Exit Codes}{subsection.15.13.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.13.5}See Also}{62}{subsection.15.13.5}}
-\newlabel{man/pcp:see-also}{{15.13.5}{62}{See Also}{subsection.15.13.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {15.14}The \textbf {\texttt {expire\_backups}} command}{62}{section.15.14}}
-\newlabel{man/expire_backups::doc}{{15.14}{62}{The \textbf {\texttt {expire\_backups}} command}{section.15.14}{}}
-\newlabel{man/expire_backups:the-command-command}{{15.14}{62}{The \textbf {\texttt {expire\_backups}} command}{section.15.14}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.14.1}Synopsis}{62}{subsection.15.14.1}}
-\newlabel{man/expire_backups:synopsis}{{15.14.1}{62}{Synopsis}{subsection.15.14.1}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.14.2}Description}{62}{subsection.15.14.2}}
-\newlabel{man/expire_backups:description}{{15.14.2}{62}{Description}{subsection.15.14.2}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.14.3}Options}{63}{subsection.15.14.3}}
-\newlabel{man/expire_backups:options}{{15.14.3}{63}{Options}{subsection.15.14.3}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.14.4}Exit Codes}{64}{subsection.15.14.4}}
-\newlabel{man/expire_backups:exit-codes}{{15.14.4}{64}{Exit Codes}{subsection.15.14.4}{}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {15.14.5}See Also}{64}{subsection.15.14.5}}
-\newlabel{man/expire_backups:see-also}{{15.14.5}{64}{See Also}{subsection.15.14.5}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {16}Further Resources / Getting Help}{65}{chapter.16}}
+\newlabel{man/index:manpages}{{16}{51}{Manpages}{chapter.16}{}}
+\newlabel{man/index::doc}{{16}{51}{Manpages}{chapter.16}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.1}The \sphinxstyleliteralstrong {\sphinxupquote {mkfs.s3ql}} command}{51}{section.16.1}}
+\newlabel{man/mkfs:the-command-command}{{16.1}{51}{The \sphinxstyleliteralstrong {\sphinxupquote {mkfs.s3ql}} command}{section.16.1}{}}
+\newlabel{man/mkfs::doc}{{16.1}{51}{The \sphinxstyleliteralstrong {\sphinxupquote {mkfs.s3ql}} command}{section.16.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.1.1}Synopsis}{51}{subsection.16.1.1}}
+\newlabel{man/mkfs:synopsis}{{16.1.1}{51}{Synopsis}{subsection.16.1.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.1.2}Description}{51}{subsection.16.1.2}}
+\newlabel{man/mkfs:description}{{16.1.2}{51}{Description}{subsection.16.1.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.1.3}Options}{51}{subsection.16.1.3}}
+\newlabel{man/mkfs:options}{{16.1.3}{51}{Options}{subsection.16.1.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.1.4}Exit Codes}{52}{subsection.16.1.4}}
+\newlabel{man/mkfs:exit-codes}{{16.1.4}{52}{Exit Codes}{subsection.16.1.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.1.5}See Also}{52}{subsection.16.1.5}}
+\newlabel{man/mkfs:see-also}{{16.1.5}{52}{See Also}{subsection.16.1.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.2}The \sphinxstyleliteralstrong {\sphinxupquote {s3qladm}} command}{52}{section.16.2}}
+\newlabel{man/adm:the-command-command}{{16.2}{52}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qladm}} command}{section.16.2}{}}
+\newlabel{man/adm::doc}{{16.2}{52}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qladm}} command}{section.16.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.2.1}Synopsis}{52}{subsection.16.2.1}}
+\newlabel{man/adm:synopsis}{{16.2.1}{52}{Synopsis}{subsection.16.2.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.2.2}Description}{53}{subsection.16.2.2}}
+\newlabel{man/adm:description}{{16.2.2}{53}{Description}{subsection.16.2.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.2.3}Options}{53}{subsection.16.2.3}}
+\newlabel{man/adm:options}{{16.2.3}{53}{Options}{subsection.16.2.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.2.4}Actions}{53}{subsection.16.2.4}}
+\newlabel{man/adm:actions}{{16.2.4}{53}{Actions}{subsection.16.2.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.2.5}Exit Codes}{53}{subsection.16.2.5}}
+\newlabel{man/adm:exit-codes}{{16.2.5}{53}{Exit Codes}{subsection.16.2.5}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.2.6}See Also}{54}{subsection.16.2.6}}
+\newlabel{man/adm:see-also}{{16.2.6}{54}{See Also}{subsection.16.2.6}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.3}The \sphinxstyleliteralstrong {\sphinxupquote {mount.s3ql}} command}{54}{section.16.3}}
+\newlabel{man/mount:the-command-command}{{16.3}{54}{The \sphinxstyleliteralstrong {\sphinxupquote {mount.s3ql}} command}{section.16.3}{}}
+\newlabel{man/mount::doc}{{16.3}{54}{The \sphinxstyleliteralstrong {\sphinxupquote {mount.s3ql}} command}{section.16.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.3.1}Synopsis}{54}{subsection.16.3.1}}
+\newlabel{man/mount:synopsis}{{16.3.1}{54}{Synopsis}{subsection.16.3.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.3.2}Description}{54}{subsection.16.3.2}}
+\newlabel{man/mount:description}{{16.3.2}{54}{Description}{subsection.16.3.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.3.3}Options}{54}{subsection.16.3.3}}
+\newlabel{man/mount:options}{{16.3.3}{54}{Options}{subsection.16.3.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.3.4}Exit Codes}{55}{subsection.16.3.4}}
+\newlabel{man/mount:exit-codes}{{16.3.4}{55}{Exit Codes}{subsection.16.3.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.3.5}See Also}{56}{subsection.16.3.5}}
+\newlabel{man/mount:see-also}{{16.3.5}{56}{See Also}{subsection.16.3.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.4}The \sphinxstyleliteralstrong {\sphinxupquote {s3qlstat}} command}{56}{section.16.4}}
+\newlabel{man/stat:the-command-command}{{16.4}{56}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qlstat}} command}{section.16.4}{}}
+\newlabel{man/stat::doc}{{16.4}{56}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qlstat}} command}{section.16.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.4.1}Synopsis}{56}{subsection.16.4.1}}
+\newlabel{man/stat:synopsis}{{16.4.1}{56}{Synopsis}{subsection.16.4.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.4.2}Description}{56}{subsection.16.4.2}}
+\newlabel{man/stat:description}{{16.4.2}{56}{Description}{subsection.16.4.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.4.3}Options}{57}{subsection.16.4.3}}
+\newlabel{man/stat:options}{{16.4.3}{57}{Options}{subsection.16.4.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.4.4}Exit Codes}{57}{subsection.16.4.4}}
+\newlabel{man/stat:exit-codes}{{16.4.4}{57}{Exit Codes}{subsection.16.4.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.4.5}See Also}{57}{subsection.16.4.5}}
+\newlabel{man/stat:see-also}{{16.4.5}{57}{See Also}{subsection.16.4.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.5}The \sphinxstyleliteralstrong {\sphinxupquote {s3qlctrl}} command}{57}{section.16.5}}
+\newlabel{man/ctrl:the-command-command}{{16.5}{57}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qlctrl}} command}{section.16.5}{}}
+\newlabel{man/ctrl::doc}{{16.5}{57}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qlctrl}} command}{section.16.5}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.5.1}Synopsis}{57}{subsection.16.5.1}}
+\newlabel{man/ctrl:synopsis}{{16.5.1}{57}{Synopsis}{subsection.16.5.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.5.2}Description}{57}{subsection.16.5.2}}
+\newlabel{man/ctrl:description}{{16.5.2}{57}{Description}{subsection.16.5.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.5.3}Options}{58}{subsection.16.5.3}}
+\newlabel{man/ctrl:options}{{16.5.3}{58}{Options}{subsection.16.5.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.5.4}Exit Codes}{58}{subsection.16.5.4}}
+\newlabel{man/ctrl:exit-codes}{{16.5.4}{58}{Exit Codes}{subsection.16.5.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.5.5}See Also}{58}{subsection.16.5.5}}
+\newlabel{man/ctrl:see-also}{{16.5.5}{58}{See Also}{subsection.16.5.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.6}The \sphinxstyleliteralstrong {\sphinxupquote {s3qlcp}} command}{58}{section.16.6}}
+\newlabel{man/cp:the-command-command}{{16.6}{58}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qlcp}} command}{section.16.6}{}}
+\newlabel{man/cp::doc}{{16.6}{58}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qlcp}} command}{section.16.6}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.6.1}Synopsis}{58}{subsection.16.6.1}}
+\newlabel{man/cp:synopsis}{{16.6.1}{58}{Synopsis}{subsection.16.6.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.6.2}Description}{59}{subsection.16.6.2}}
+\newlabel{man/cp:description}{{16.6.2}{59}{Description}{subsection.16.6.2}{}}
+\@writefile{toc}{\contentsline {subsubsection}{Snapshotting vs Hardlinking}{59}{subsubsection*.22}}
+\newlabel{man/cp:snapshotting-vs-hardlinking}{{16.6.2}{59}{Snapshotting vs Hardlinking}{subsubsection*.22}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.6.3}Options}{59}{subsection.16.6.3}}
+\newlabel{man/cp:options}{{16.6.3}{59}{Options}{subsection.16.6.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.6.4}Exit Codes}{59}{subsection.16.6.4}}
+\newlabel{man/cp:exit-codes}{{16.6.4}{59}{Exit Codes}{subsection.16.6.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.6.5}See Also}{60}{subsection.16.6.5}}
+\newlabel{man/cp:see-also}{{16.6.5}{60}{See Also}{subsection.16.6.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.7}The \sphinxstyleliteralstrong {\sphinxupquote {s3qlrm}} command}{60}{section.16.7}}
+\newlabel{man/rm:the-command-command}{{16.7}{60}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qlrm}} command}{section.16.7}{}}
+\newlabel{man/rm::doc}{{16.7}{60}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qlrm}} command}{section.16.7}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.7.1}Synopsis}{60}{subsection.16.7.1}}
+\newlabel{man/rm:synopsis}{{16.7.1}{60}{Synopsis}{subsection.16.7.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.7.2}Description}{60}{subsection.16.7.2}}
+\newlabel{man/rm:description}{{16.7.2}{60}{Description}{subsection.16.7.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.7.3}Options}{60}{subsection.16.7.3}}
+\newlabel{man/rm:options}{{16.7.3}{60}{Options}{subsection.16.7.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.7.4}Exit Codes}{60}{subsection.16.7.4}}
+\newlabel{man/rm:exit-codes}{{16.7.4}{60}{Exit Codes}{subsection.16.7.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.7.5}See Also}{61}{subsection.16.7.5}}
+\newlabel{man/rm:see-also}{{16.7.5}{61}{See Also}{subsection.16.7.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.8}The \sphinxstyleliteralstrong {\sphinxupquote {s3qllock}} command}{61}{section.16.8}}
+\newlabel{man/lock:the-command-command}{{16.8}{61}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qllock}} command}{section.16.8}{}}
+\newlabel{man/lock::doc}{{16.8}{61}{The \sphinxstyleliteralstrong {\sphinxupquote {s3qllock}} command}{section.16.8}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.8.1}Synopsis}{61}{subsection.16.8.1}}
+\newlabel{man/lock:synopsis}{{16.8.1}{61}{Synopsis}{subsection.16.8.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.8.2}Description}{61}{subsection.16.8.2}}
+\newlabel{man/lock:description}{{16.8.2}{61}{Description}{subsection.16.8.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.8.3}Rationale}{61}{subsection.16.8.3}}
+\newlabel{man/lock:rationale}{{16.8.3}{61}{Rationale}{subsection.16.8.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.8.4}Options}{61}{subsection.16.8.4}}
+\newlabel{man/lock:options}{{16.8.4}{61}{Options}{subsection.16.8.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.8.5}Exit Codes}{62}{subsection.16.8.5}}
+\newlabel{man/lock:exit-codes}{{16.8.5}{62}{Exit Codes}{subsection.16.8.5}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.8.6}See Also}{62}{subsection.16.8.6}}
+\newlabel{man/lock:see-also}{{16.8.6}{62}{See Also}{subsection.16.8.6}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.9}The \sphinxstyleliteralstrong {\sphinxupquote {umount.s3ql}} command}{62}{section.16.9}}
+\newlabel{man/umount:the-command-command}{{16.9}{62}{The \sphinxstyleliteralstrong {\sphinxupquote {umount.s3ql}} command}{section.16.9}{}}
+\newlabel{man/umount::doc}{{16.9}{62}{The \sphinxstyleliteralstrong {\sphinxupquote {umount.s3ql}} command}{section.16.9}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.9.1}Synopsis}{62}{subsection.16.9.1}}
+\newlabel{man/umount:synopsis}{{16.9.1}{62}{Synopsis}{subsection.16.9.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.9.2}Description}{62}{subsection.16.9.2}}
+\newlabel{man/umount:description}{{16.9.2}{62}{Description}{subsection.16.9.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.9.3}Options}{62}{subsection.16.9.3}}
+\newlabel{man/umount:options}{{16.9.3}{62}{Options}{subsection.16.9.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.9.4}Exit Codes}{63}{subsection.16.9.4}}
+\newlabel{man/umount:exit-codes}{{16.9.4}{63}{Exit Codes}{subsection.16.9.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.9.5}See Also}{63}{subsection.16.9.5}}
+\newlabel{man/umount:see-also}{{16.9.5}{63}{See Also}{subsection.16.9.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.10}The \sphinxstyleliteralstrong {\sphinxupquote {fsck.s3ql}} command}{63}{section.16.10}}
+\newlabel{man/fsck:the-command-command}{{16.10}{63}{The \sphinxstyleliteralstrong {\sphinxupquote {fsck.s3ql}} command}{section.16.10}{}}
+\newlabel{man/fsck::doc}{{16.10}{63}{The \sphinxstyleliteralstrong {\sphinxupquote {fsck.s3ql}} command}{section.16.10}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.10.1}Synopsis}{63}{subsection.16.10.1}}
+\newlabel{man/fsck:synopsis}{{16.10.1}{63}{Synopsis}{subsection.16.10.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.10.2}Description}{63}{subsection.16.10.2}}
+\newlabel{man/fsck:description}{{16.10.2}{63}{Description}{subsection.16.10.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.10.3}Options}{63}{subsection.16.10.3}}
+\newlabel{man/fsck:options}{{16.10.3}{63}{Options}{subsection.16.10.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.10.4}Exit Codes}{64}{subsection.16.10.4}}
+\newlabel{man/fsck:exit-codes}{{16.10.4}{64}{Exit Codes}{subsection.16.10.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.10.5}See Also}{65}{subsection.16.10.5}}
+\newlabel{man/fsck:see-also}{{16.10.5}{65}{See Also}{subsection.16.10.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.11}The \sphinxstyleliteralstrong {\sphinxupquote {s3ql\_oauth\_client}} command}{65}{section.16.11}}
+\newlabel{man/oauth_client:the-command-command}{{16.11}{65}{The \sphinxstyleliteralstrong {\sphinxupquote {s3ql\_oauth\_client}} command}{section.16.11}{}}
+\newlabel{man/oauth_client:oauth-client}{{16.11}{65}{The \sphinxstyleliteralstrong {\sphinxupquote {s3ql\_oauth\_client}} command}{section.16.11}{}}
+\newlabel{man/oauth_client::doc}{{16.11}{65}{The \sphinxstyleliteralstrong {\sphinxupquote {s3ql\_oauth\_client}} command}{section.16.11}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.11.1}Synopsis}{65}{subsection.16.11.1}}
+\newlabel{man/oauth_client:synopsis}{{16.11.1}{65}{Synopsis}{subsection.16.11.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.11.2}Description}{65}{subsection.16.11.2}}
+\newlabel{man/oauth_client:description}{{16.11.2}{65}{Description}{subsection.16.11.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.11.3}Options}{65}{subsection.16.11.3}}
+\newlabel{man/oauth_client:options}{{16.11.3}{65}{Options}{subsection.16.11.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.11.4}Exit Codes}{65}{subsection.16.11.4}}
+\newlabel{man/oauth_client:exit-codes}{{16.11.4}{65}{Exit Codes}{subsection.16.11.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.11.5}See Also}{66}{subsection.16.11.5}}
+\newlabel{man/oauth_client:see-also}{{16.11.5}{66}{See Also}{subsection.16.11.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.12}The \sphinxstyleliteralstrong {\sphinxupquote {s3ql\_verify}} command}{66}{section.16.12}}
+\newlabel{man/verify:the-command-command}{{16.12}{66}{The \sphinxstyleliteralstrong {\sphinxupquote {s3ql\_verify}} command}{section.16.12}{}}
+\newlabel{man/verify::doc}{{16.12}{66}{The \sphinxstyleliteralstrong {\sphinxupquote {s3ql\_verify}} command}{section.16.12}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.12.1}Synopsis}{66}{subsection.16.12.1}}
+\newlabel{man/verify:synopsis}{{16.12.1}{66}{Synopsis}{subsection.16.12.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.12.2}Description}{66}{subsection.16.12.2}}
+\newlabel{man/verify:description}{{16.12.2}{66}{Description}{subsection.16.12.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.12.3}Options}{66}{subsection.16.12.3}}
+\newlabel{man/verify:options}{{16.12.3}{66}{Options}{subsection.16.12.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.12.4}Exit Codes}{67}{subsection.16.12.4}}
+\newlabel{man/verify:exit-codes}{{16.12.4}{67}{Exit Codes}{subsection.16.12.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.12.5}See Also}{67}{subsection.16.12.5}}
+\newlabel{man/verify:see-also}{{16.12.5}{67}{See Also}{subsection.16.12.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.13}The \sphinxstyleliteralstrong {\sphinxupquote {pcp}} command}{67}{section.16.13}}
+\newlabel{man/pcp:the-command-command}{{16.13}{67}{The \sphinxstyleliteralstrong {\sphinxupquote {pcp}} command}{section.16.13}{}}
+\newlabel{man/pcp::doc}{{16.13}{67}{The \sphinxstyleliteralstrong {\sphinxupquote {pcp}} command}{section.16.13}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.13.1}Synopsis}{67}{subsection.16.13.1}}
+\newlabel{man/pcp:synopsis}{{16.13.1}{67}{Synopsis}{subsection.16.13.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.13.2}Description}{67}{subsection.16.13.2}}
+\newlabel{man/pcp:description}{{16.13.2}{67}{Description}{subsection.16.13.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.13.3}Options}{68}{subsection.16.13.3}}
+\newlabel{man/pcp:options}{{16.13.3}{68}{Options}{subsection.16.13.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.13.4}Exit Codes}{68}{subsection.16.13.4}}
+\newlabel{man/pcp:exit-codes}{{16.13.4}{68}{Exit Codes}{subsection.16.13.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.13.5}See Also}{68}{subsection.16.13.5}}
+\newlabel{man/pcp:see-also}{{16.13.5}{68}{See Also}{subsection.16.13.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {16.14}The \sphinxstyleliteralstrong {\sphinxupquote {expire\_backups}} command}{68}{section.16.14}}
+\newlabel{man/expire_backups:the-command-command}{{16.14}{68}{The \sphinxstyleliteralstrong {\sphinxupquote {expire\_backups}} command}{section.16.14}{}}
+\newlabel{man/expire_backups::doc}{{16.14}{68}{The \sphinxstyleliteralstrong {\sphinxupquote {expire\_backups}} command}{section.16.14}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.14.1}Synopsis}{68}{subsection.16.14.1}}
+\newlabel{man/expire_backups:synopsis}{{16.14.1}{68}{Synopsis}{subsection.16.14.1}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.14.2}Description}{68}{subsection.16.14.2}}
+\newlabel{man/expire_backups:description}{{16.14.2}{68}{Description}{subsection.16.14.2}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.14.3}Options}{69}{subsection.16.14.3}}
+\newlabel{man/expire_backups:options}{{16.14.3}{69}{Options}{subsection.16.14.3}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.14.4}Exit Codes}{70}{subsection.16.14.4}}
+\newlabel{man/expire_backups:exit-codes}{{16.14.4}{70}{Exit Codes}{subsection.16.14.4}{}}
+\@writefile{toc}{\contentsline {subsection}{\numberline {16.14.5}See Also}{70}{subsection.16.14.5}}
+\newlabel{man/expire_backups:see-also}{{16.14.5}{70}{See Also}{subsection.16.14.5}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {17}Further Resources / Getting Help}{71}{chapter.17}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{resources::doc}{{16}{65}{Further Resources / Getting Help}{chapter.16}{}}
-\newlabel{resources:further-resources-getting-help}{{16}{65}{Further Resources / Getting Help}{chapter.16}{}}
-\newlabel{resources:resources}{{16}{65}{Further Resources / Getting Help}{chapter.16}{}}
-\@writefile{toc}{\contentsline {chapter}{\numberline {17}Implementation Details}{67}{chapter.17}}
+\newlabel{resources:further-resources-getting-help}{{17}{71}{Further Resources / Getting Help}{chapter.17}{}}
+\newlabel{resources:resources}{{17}{71}{Further Resources / Getting Help}{chapter.17}{}}
+\newlabel{resources::doc}{{17}{71}{Further Resources / Getting Help}{chapter.17}{}}
+\@writefile{toc}{\contentsline {chapter}{\numberline {18}Implementation Details}{73}{chapter.18}}
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
-\@writefile{loliteral-block}{\addvspace {10\p@ }}
-\newlabel{impl_details:implementation-details}{{17}{67}{Implementation Details}{chapter.17}{}}
-\newlabel{impl_details::doc}{{17}{67}{Implementation Details}{chapter.17}{}}
-\newlabel{impl_details:impl-details}{{17}{67}{Implementation Details}{chapter.17}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {17.1}Metadata Storage}{67}{section.17.1}}
-\newlabel{impl_details:metadata-storage}{{17.1}{67}{Metadata Storage}{section.17.1}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {17.2}Data Storage}{67}{section.17.2}}
-\newlabel{impl_details:data-storage}{{17.2}{67}{Data Storage}{section.17.2}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {17.3}Data De-Duplication}{68}{section.17.3}}
-\newlabel{impl_details:data-de-duplication}{{17.3}{68}{Data De-Duplication}{section.17.3}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {17.4}Caching}{68}{section.17.4}}
-\newlabel{impl_details:caching}{{17.4}{68}{Caching}{section.17.4}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {17.5}Eventual Consistency Handling}{68}{section.17.5}}
-\newlabel{impl_details:eventual-consistency-handling}{{17.5}{68}{Eventual Consistency Handling}{section.17.5}{}}
-\@writefile{toc}{\contentsline {section}{\numberline {17.6}Encryption}{68}{section.17.6}}
-\newlabel{impl_details:encryption}{{17.6}{68}{Encryption}{section.17.6}{}}
+\newlabel{impl_details:implementation-details}{{18}{73}{Implementation Details}{chapter.18}{}}
+\newlabel{impl_details:impl-details}{{18}{73}{Implementation Details}{chapter.18}{}}
+\newlabel{impl_details::doc}{{18}{73}{Implementation Details}{chapter.18}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {18.1}Metadata Storage}{73}{section.18.1}}
+\newlabel{impl_details:metadata-storage}{{18.1}{73}{Metadata Storage}{section.18.1}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {18.2}Data Storage}{73}{section.18.2}}
+\newlabel{impl_details:data-storage}{{18.2}{73}{Data Storage}{section.18.2}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {18.3}Data De-Duplication}{74}{section.18.3}}
+\newlabel{impl_details:data-de-duplication}{{18.3}{74}{Data De-Duplication}{section.18.3}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {18.4}Caching}{74}{section.18.4}}
+\newlabel{impl_details:caching}{{18.4}{74}{Caching}{section.18.4}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {18.5}Eventual Consistency Handling}{74}{section.18.5}}
+\newlabel{impl_details:eventual-consistency-handling}{{18.5}{74}{Eventual Consistency Handling}{section.18.5}{}}
+\@writefile{toc}{\contentsline {section}{\numberline {18.6}Encryption}{74}{section.18.6}}
+\newlabel{impl_details:encryption}{{18.6}{74}{Encryption}{section.18.6}{}}
diff --git a/doc/latex/manual.out b/doc/latex/manual.out
index 1cf7a2e..bf8b8e3 100644
--- a/doc/latex/manual.out
+++ b/doc/latex/manual.out
@@ -55,27 +55,42 @@
\BOOKMARK [1][-]{section.13.1}{\376\377\000S\000S\000H\000\040\000B\000a\000c\000k\000e\000n\000d}{chapter.13}% 55
\BOOKMARK [1][-]{section.13.2}{\376\377\000P\000e\000r\000m\000a\000n\000e\000n\000t\000l\000y\000\040\000m\000o\000u\000n\000t\000e\000d\000\040\000b\000a\000c\000k\000u\000p\000\040\000f\000i\000l\000e\000\040\000s\000y\000s\000t\000e\000m}{chapter.13}% 56
\BOOKMARK [1][-]{section.13.3}{\376\377\000I\000m\000p\000r\000o\000v\000i\000n\000g\000\040\000c\000o\000p\000y\000\040\000p\000e\000r\000f\000o\000r\000m\000a\000n\000c\000e}{chapter.13}% 57
-\BOOKMARK [0][-]{chapter.14}{\376\377\000K\000n\000o\000w\000n\000\040\000I\000s\000s\000u\000e\000s}{}% 58
-\BOOKMARK [0][-]{chapter.15}{\376\377\000M\000a\000n\000p\000a\000g\000e\000s}{}% 59
-\BOOKMARK [1][-]{section.15.1}{\376\377\000T\000h\000e\000\040\000m\000k\000f\000s\000.\000s\0003\000q\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 60
-\BOOKMARK [1][-]{section.15.2}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000a\000d\000m\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 61
-\BOOKMARK [1][-]{section.15.3}{\376\377\000T\000h\000e\000\040\000m\000o\000u\000n\000t\000.\000s\0003\000q\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 62
-\BOOKMARK [1][-]{section.15.4}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000s\000t\000a\000t\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 63
-\BOOKMARK [1][-]{section.15.5}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000c\000t\000r\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 64
-\BOOKMARK [1][-]{section.15.6}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000c\000p\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 65
-\BOOKMARK [1][-]{section.15.7}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000r\000m\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 66
-\BOOKMARK [1][-]{section.15.8}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000l\000o\000c\000k\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 67
-\BOOKMARK [1][-]{section.15.9}{\376\377\000T\000h\000e\000\040\000u\000m\000o\000u\000n\000t\000.\000s\0003\000q\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 68
-\BOOKMARK [1][-]{section.15.10}{\376\377\000T\000h\000e\000\040\000f\000s\000c\000k\000.\000s\0003\000q\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 69
-\BOOKMARK [1][-]{section.15.11}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000\137\000o\000a\000u\000t\000h\000\137\000c\000l\000i\000e\000n\000t\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 70
-\BOOKMARK [1][-]{section.15.12}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000\137\000v\000e\000r\000i\000f\000y\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 71
-\BOOKMARK [1][-]{section.15.13}{\376\377\000T\000h\000e\000\040\000p\000c\000p\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 72
-\BOOKMARK [1][-]{section.15.14}{\376\377\000T\000h\000e\000\040\000e\000x\000p\000i\000r\000e\000\137\000b\000a\000c\000k\000u\000p\000s\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.15}% 73
-\BOOKMARK [0][-]{chapter.16}{\376\377\000F\000u\000r\000t\000h\000e\000r\000\040\000R\000e\000s\000o\000u\000r\000c\000e\000s\000\040\000/\000\040\000G\000e\000t\000t\000i\000n\000g\000\040\000H\000e\000l\000p}{}% 74
-\BOOKMARK [0][-]{chapter.17}{\376\377\000I\000m\000p\000l\000e\000m\000e\000n\000t\000a\000t\000i\000o\000n\000\040\000D\000e\000t\000a\000i\000l\000s}{}% 75
-\BOOKMARK [1][-]{section.17.1}{\376\377\000M\000e\000t\000a\000d\000a\000t\000a\000\040\000S\000t\000o\000r\000a\000g\000e}{chapter.17}% 76
-\BOOKMARK [1][-]{section.17.2}{\376\377\000D\000a\000t\000a\000\040\000S\000t\000o\000r\000a\000g\000e}{chapter.17}% 77
-\BOOKMARK [1][-]{section.17.3}{\376\377\000D\000a\000t\000a\000\040\000D\000e\000-\000D\000u\000p\000l\000i\000c\000a\000t\000i\000o\000n}{chapter.17}% 78
-\BOOKMARK [1][-]{section.17.4}{\376\377\000C\000a\000c\000h\000i\000n\000g}{chapter.17}% 79
-\BOOKMARK [1][-]{section.17.5}{\376\377\000E\000v\000e\000n\000t\000u\000a\000l\000\040\000C\000o\000n\000s\000i\000s\000t\000e\000n\000c\000y\000\040\000H\000a\000n\000d\000l\000i\000n\000g}{chapter.17}% 80
-\BOOKMARK [1][-]{section.17.6}{\376\377\000E\000n\000c\000r\000y\000p\000t\000i\000o\000n}{chapter.17}% 81
+\BOOKMARK [0][-]{chapter.14}{\376\377\000F\000r\000e\000q\000u\000e\000n\000t\000l\000y\000\040\000A\000s\000k\000e\000d\000\040\000Q\000u\000e\000s\000t\000i\000o\000n\000s}{}% 58
+\BOOKMARK [1][-]{section.14.1}{\376\377\000W\000h\000a\000t\000\040\000d\000o\000e\000s\000\040\040\034\000p\000y\000t\000h\000o\000n\000-\000a\000p\000s\000w\000\040\000m\000u\000s\000t\000\040\000b\000e\000\040\000l\000i\000n\000k\000e\000d\000\040\000d\000y\000n\000a\000m\000i\000c\000a\000l\000l\000y\000\040\000t\000o\000\040\000s\000q\000l\000i\000t\000e\0003\040\035\000\040\000m\000e\000a\000n\000?}{chapter.14}% 59
+\BOOKMARK [1][-]{section.14.2}{\376\377\000H\000o\000w\000\040\000c\000a\000n\000\040\000I\000\040\000i\000m\000p\000r\000o\000v\000e\000\040\000t\000h\000e\000\040\000f\000i\000l\000e\000\040\000s\000y\000s\000t\000e\000m\000\040\000t\000h\000r\000o\000u\000g\000h\000p\000u\000t\000?}{chapter.14}% 60
+\BOOKMARK [1][-]{section.14.3}{\376\377\000W\000h\000y\000\040\000d\000o\000e\000s\000\040\000d\000f\000\040\000s\000h\000o\000w\000\040\0001\000\040\000T\000B\000\040\000o\000f\000\040\000f\000r\000e\000e\000\040\000s\000p\000a\000c\000e\000?}{chapter.14}% 61
+\BOOKMARK [1][-]{section.14.4}{\376\377\000W\000h\000i\000c\000h\000\040\000o\000p\000e\000r\000a\000t\000i\000n\000g\000\040\000s\000y\000s\000t\000e\000m\000s\000\040\000a\000r\000e\000\040\000s\000u\000p\000p\000o\000r\000t\000e\000d\000?}{chapter.14}% 62
+\BOOKMARK [1][-]{section.14.5}{\376\377\000I\000s\000\040\000t\000h\000e\000r\000e\000\040\000a\000\040\000f\000i\000l\000e\000\040\000s\000i\000z\000e\000\040\000l\000i\000m\000i\000t\000?}{chapter.14}% 63
+\BOOKMARK [1][-]{section.14.6}{\376\377\000S\000u\000p\000p\000o\000s\000e\000\040\000I\000\040\000w\000a\000n\000t\000\040\000t\000o\000\040\000m\000a\000k\000e\000\040\000a\000\040\000s\000m\000a\000l\000l\000\040\000c\000h\000a\000n\000g\000e\000\040\000i\000n\000\040\000a\000\040\000v\000e\000r\000y\000\040\000l\000a\000r\000g\000e\000\040\000f\000i\000l\000e\000.\000\040\000W\000i\000l\000l\000\040\000S\0003\000Q\000L\000\040\000d\000o\000w\000n\000l\000o\000a\000d\000\040\000a\000n\000d\000\040\000r\000e\000-\000u\000p\000l\000o\000a\000d\000\040\000t\000h\000e\000\040\000e\000n\000t\000i\000r\000e\000\040\000f\000i\000l\000e\000?}{chapter.14}% 64
+\BOOKMARK [1][-]{section.14.7}{\376\377\000I\000\040\000d\000o\000n\040\031\000t\000\040\000q\000u\000i\000t\000e\000\040\000u\000n\000d\000e\000r\000s\000t\000a\000n\000d\000\040\000t\000h\000i\000s\000\040\000d\000e\000-\000d\000u\000p\000l\000i\000c\000a\000t\000i\000o\000n\000\040\000f\000e\000a\000t\000u\000r\000e\040\046}{chapter.14}% 65
+\BOOKMARK [1][-]{section.14.8}{\376\377\000W\000h\000a\000t\000\040\000d\000o\000e\000s\000\040\000t\000h\000e\000\040\040\034\000T\000r\000a\000n\000s\000p\000o\000r\000t\000\040\000e\000n\000d\000p\000o\000i\000n\000t\000\040\000n\000o\000t\000\040\000c\000o\000n\000n\000e\000c\000t\000e\000d\040\035\000\040\000e\000r\000r\000o\000r\000\040\000m\000e\000a\000n\000?}{chapter.14}% 66
+\BOOKMARK [1][-]{section.14.9}{\376\377\000W\000h\000a\000t\000\040\000d\000o\000e\000s\000\040\040\034\000B\000a\000c\000k\000e\000n\000d\000\040\000r\000e\000p\000o\000r\000t\000s\000\040\000t\000h\000a\000t\000\040\000f\000s\000\040\000i\000s\000\040\000s\000t\000i\000l\000l\000\040\000m\000o\000u\000n\000t\000e\000d\000\040\000e\000l\000s\000e\000w\000h\000e\000r\000e\000,\000\040\000a\000b\000o\000r\000t\000i\000n\000g\040\035\000\040\000m\000e\000a\000n\000?}{chapter.14}% 67
+\BOOKMARK [1][-]{section.14.10}{\376\377\000C\000a\000n\000\040\000I\000\040\000a\000c\000c\000e\000s\000s\000\040\000a\000n\000\040\000S\0003\000Q\000L\000\040\000f\000i\000l\000e\000\040\000s\000y\000s\000t\000e\000m\000\040\000o\000n\000\040\000m\000u\000l\000t\000i\000p\000l\000e\000\040\000c\000o\000m\000p\000u\000t\000e\000r\000s\000\040\000s\000i\000m\000u\000l\000t\000a\000n\000e\000o\000u\000s\000l\000y\000?}{chapter.14}% 68
+\BOOKMARK [1][-]{section.14.11}{\376\377\000W\000h\000a\000t\000\040\000m\000a\000x\000i\000m\000u\000m\000\040\000o\000b\000j\000e\000c\000t\000\040\000s\000i\000z\000e\000\040\000s\000h\000o\000u\000l\000d\000\040\000I\000\040\000u\000s\000e\000?}{chapter.14}% 69
+\BOOKMARK [1][-]{section.14.12}{\376\377\000I\000s\000\040\000t\000h\000e\000r\000e\000\040\000a\000\040\000w\000a\000y\000\040\000t\000o\000\040\000m\000a\000k\000e\000\040\000t\000h\000e\000\040\000c\000a\000c\000h\000e\000\040\000p\000e\000r\000s\000i\000s\000t\000e\000n\000t\000\040\000/\000\040\000a\000c\000c\000e\000s\000s\000\040\000t\000h\000e\000\040\000f\000i\000l\000e\000\040\000s\000y\000s\000t\000e\000m\000\040\000o\000f\000f\000l\000i\000n\000e\000?}{chapter.14}% 70
+\BOOKMARK [1][-]{section.14.13}{\376\377\000I\000\040\000w\000o\000u\000l\000d\000\040\000l\000i\000k\000e\000\040\000t\000o\000\040\000u\000s\000e\000\040\000S\0003\000Q\000L\000\040\000w\000i\000t\000h\000\040\000H\000u\000b\000i\000c\000,\000\040\000b\000u\000t\040\046}{chapter.14}% 71
+\BOOKMARK [1][-]{section.14.14}{\376\377\000W\000h\000a\000t\040\031\000s\000\040\000a\000\040\000r\000e\000a\000s\000o\000n\000a\000b\000l\000e\000\040\000m\000e\000t\000a\000d\000a\000t\000a\000\040\000u\000p\000l\000o\000a\000d\000\040\000i\000n\000t\000e\000r\000v\000a\000l\000?}{chapter.14}% 72
+\BOOKMARK [0][-]{chapter.15}{\376\377\000K\000n\000o\000w\000n\000\040\000I\000s\000s\000u\000e\000s}{}% 73
+\BOOKMARK [0][-]{chapter.16}{\376\377\000M\000a\000n\000p\000a\000g\000e\000s}{}% 74
+\BOOKMARK [1][-]{section.16.1}{\376\377\000T\000h\000e\000\040\000m\000k\000f\000s\000.\000s\0003\000q\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 75
+\BOOKMARK [1][-]{section.16.2}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000a\000d\000m\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 76
+\BOOKMARK [1][-]{section.16.3}{\376\377\000T\000h\000e\000\040\000m\000o\000u\000n\000t\000.\000s\0003\000q\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 77
+\BOOKMARK [1][-]{section.16.4}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000s\000t\000a\000t\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 78
+\BOOKMARK [1][-]{section.16.5}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000c\000t\000r\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 79
+\BOOKMARK [1][-]{section.16.6}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000c\000p\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 80
+\BOOKMARK [1][-]{section.16.7}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000r\000m\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 81
+\BOOKMARK [1][-]{section.16.8}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000l\000o\000c\000k\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 82
+\BOOKMARK [1][-]{section.16.9}{\376\377\000T\000h\000e\000\040\000u\000m\000o\000u\000n\000t\000.\000s\0003\000q\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 83
+\BOOKMARK [1][-]{section.16.10}{\376\377\000T\000h\000e\000\040\000f\000s\000c\000k\000.\000s\0003\000q\000l\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 84
+\BOOKMARK [1][-]{section.16.11}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000\137\000o\000a\000u\000t\000h\000\137\000c\000l\000i\000e\000n\000t\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 85
+\BOOKMARK [1][-]{section.16.12}{\376\377\000T\000h\000e\000\040\000s\0003\000q\000l\000\137\000v\000e\000r\000i\000f\000y\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 86
+\BOOKMARK [1][-]{section.16.13}{\376\377\000T\000h\000e\000\040\000p\000c\000p\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 87
+\BOOKMARK [1][-]{section.16.14}{\376\377\000T\000h\000e\000\040\000e\000x\000p\000i\000r\000e\000\137\000b\000a\000c\000k\000u\000p\000s\000\040\000c\000o\000m\000m\000a\000n\000d}{chapter.16}% 88
+\BOOKMARK [0][-]{chapter.17}{\376\377\000F\000u\000r\000t\000h\000e\000r\000\040\000R\000e\000s\000o\000u\000r\000c\000e\000s\000\040\000/\000\040\000G\000e\000t\000t\000i\000n\000g\000\040\000H\000e\000l\000p}{}% 89
+\BOOKMARK [0][-]{chapter.18}{\376\377\000I\000m\000p\000l\000e\000m\000e\000n\000t\000a\000t\000i\000o\000n\000\040\000D\000e\000t\000a\000i\000l\000s}{}% 90
+\BOOKMARK [1][-]{section.18.1}{\376\377\000M\000e\000t\000a\000d\000a\000t\000a\000\040\000S\000t\000o\000r\000a\000g\000e}{chapter.18}% 91
+\BOOKMARK [1][-]{section.18.2}{\376\377\000D\000a\000t\000a\000\040\000S\000t\000o\000r\000a\000g\000e}{chapter.18}% 92
+\BOOKMARK [1][-]{section.18.3}{\376\377\000D\000a\000t\000a\000\040\000D\000e\000-\000D\000u\000p\000l\000i\000c\000a\000t\000i\000o\000n}{chapter.18}% 93
+\BOOKMARK [1][-]{section.18.4}{\376\377\000C\000a\000c\000h\000i\000n\000g}{chapter.18}% 94
+\BOOKMARK [1][-]{section.18.5}{\376\377\000E\000v\000e\000n\000t\000u\000a\000l\000\040\000C\000o\000n\000s\000i\000s\000t\000e\000n\000c\000y\000\040\000H\000a\000n\000d\000l\000i\000n\000g}{chapter.18}% 95
+\BOOKMARK [1][-]{section.18.6}{\376\377\000E\000n\000c\000r\000y\000p\000t\000i\000o\000n}{chapter.18}% 96
diff --git a/doc/latex/manual.pdf b/doc/latex/manual.pdf
deleted file mode 100644
index 9829e21..0000000
--- a/doc/latex/manual.pdf
+++ /dev/null
Binary files differ
diff --git a/doc/latex/manual.tex b/doc/latex/manual.tex
index d714373..52543df 100644
--- a/doc/latex/manual.tex
+++ b/doc/latex/manual.tex
@@ -1,14 +1,21 @@
-% Generated by Sphinx.
+%% Generated by Sphinx.
\def\sphinxdocclass{report}
-\newif\ifsphinxKeepOldNames \sphinxKeepOldNamestrue
\documentclass[letterpaper,10pt,english]{sphinxmanual}
-\usepackage{iftex}
+\ifdefined\pdfpxdimen
+ \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen
+\fi \sphinxpxdimen=.75bp\relax
-\ifPDFTeX
- \usepackage[utf8]{inputenc}
-\fi
+\PassOptionsToPackage{warn}{textcomp}
+\usepackage[utf8]{inputenc}
\ifdefined\DeclareUnicodeCharacter
- \DeclareUnicodeCharacter{00A0}{\nobreakspace}
+% support both utf8 and utf8x syntaxes
+\edef\sphinxdqmaybe{\ifdefined\DeclareUnicodeCharacterAsOptional\string"\fi}
+ \DeclareUnicodeCharacter{\sphinxdqmaybe00A0}{\nobreakspace}
+ \DeclareUnicodeCharacter{\sphinxdqmaybe2500}{\sphinxunichar{2500}}
+ \DeclareUnicodeCharacter{\sphinxdqmaybe2502}{\sphinxunichar{2502}}
+ \DeclareUnicodeCharacter{\sphinxdqmaybe2514}{\sphinxunichar{2514}}
+ \DeclareUnicodeCharacter{\sphinxdqmaybe251C}{\sphinxunichar{251C}}
+ \DeclareUnicodeCharacter{\sphinxdqmaybe2572}{\textbackslash}
\fi
\usepackage{cmap}
\usepackage[T1]{fontenc}
@@ -16,143 +23,53 @@
\usepackage{babel}
\usepackage{times}
\usepackage[Bjarne]{fncychap}
-\usepackage{longtable}
\usepackage{sphinx}
-\usepackage{multirow}
-\usepackage{eqparbox}
+\fvset{fontsize=\small}
+\usepackage{geometry}
+
+% Include hyperref last.
+\usepackage{hyperref}
+% Fix anchor placement for figures with captions.
+\usepackage{hypcap}% it must be loaded after hyperref.
+% Set up styles of URL: it should be placed after hyperref.
+\urlstyle{same}
+
+\addto\captionsenglish{\renewcommand{\figurename}{Fig.}}
+\addto\captionsenglish{\renewcommand{\tablename}{Table}}
+\addto\captionsenglish{\renewcommand{\literalblockname}{Listing}}
-\addto\captionsenglish{\renewcommand{\figurename}{Fig.\@ }}
-\addto\captionsenglish{\renewcommand{\tablename}{Table }}
-\SetupFloatingEnvironment{literal-block}{name=Listing }
+\addto\captionsenglish{\renewcommand{\literalblockcontinuedname}{continued from previous page}}
+\addto\captionsenglish{\renewcommand{\literalblockcontinuesname}{continues on next page}}
+\addto\captionsenglish{\renewcommand{\sphinxnonalphabeticalgroupname}{Non-alphabetical}}
+\addto\captionsenglish{\renewcommand{\sphinxsymbolsname}{Symbols}}
+\addto\captionsenglish{\renewcommand{\sphinxnumbersname}{Numbers}}
\addto\extrasenglish{\def\pageautorefname{page}}
\setcounter{tocdepth}{1}
+
\title{S3QL Documentation}
-\date{Nov 06, 2018}
-\release{2.32}
+\date{Dec 28, 2018}
+\release{2.33}
\author{Nikolaus Rath}
-\newcommand{\sphinxlogo}{}
+\newcommand{\sphinxlogo}{\vbox{}}
\renewcommand{\releasename}{Release}
\makeindex
-
-\makeatletter
-\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax%
- \let\PYG@ul=\relax \let\PYG@tc=\relax%
- \let\PYG@bc=\relax \let\PYG@ff=\relax}
-\def\PYG@tok#1{\csname PYG@tok@#1\endcsname}
-\def\PYG@toks#1+{\ifx\relax#1\empty\else%
- \PYG@tok{#1}\expandafter\PYG@toks\fi}
-\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{%
- \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}}
-\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}}
-
-\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
-\expandafter\def\csname PYG@tok@vm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.60,0.40,0.20}{##1}}}
-\expandafter\def\csname PYG@tok@mf\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.40,0.00,0.93}{##1}}}
-\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf}
-\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.53,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.80}{##1}}}
-\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.33,0.47,0.60}{##1}}}
-\expandafter\def\csname PYG@tok@kt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.60}{##1}}}
-\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.60,0.40,0.20}{##1}}}
-\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@nf\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.40,0.73}{##1}}}
-\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}}
-\expandafter\def\csname PYG@tok@cm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.73,0.00,0.40}{##1}}}
-\expandafter\def\csname PYG@tok@mi\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.87}{##1}}}
-\expandafter\def\csname PYG@tok@sd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.87,0.27,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@cs\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.80,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@fm\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.40,0.73}{##1}}}
-\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit}
-\expandafter\def\csname PYG@tok@m\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.40,0.00,0.93}{##1}}}
-\expandafter\def\csname PYG@tok@dl\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@kp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.20,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.87,0.13,0.00}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@ne\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@c1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.40,0.60}{##1}}}
-\expandafter\def\csname PYG@tok@no\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.20,0.40}{##1}}}
-\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}}
-\expandafter\def\csname PYG@tok@nt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.47,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.67,0.40,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
-\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@cpf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@ch\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@vg\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.87,0.47,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@c\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
-\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.00}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,1.00}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@si\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{0.93,0.93,0.93}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@il\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.87}{##1}}}
-\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.60,0.47,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@mh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.33,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.67,0.67}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.73}{##1}}}
-\expandafter\def\csname PYG@tok@mo\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.27,0.00,0.93}{##1}}}
-\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
-\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}}
-\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}}
-\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}}
-\expandafter\def\csname PYG@tok@sa\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@mb\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.40,0.00,0.93}{##1}}}
-
-\def\PYGZbs{\char`\\}
-\def\PYGZus{\char`\_}
-\def\PYGZob{\char`\{}
-\def\PYGZcb{\char`\}}
-\def\PYGZca{\char`\^}
-\def\PYGZam{\char`\&}
-\def\PYGZlt{\char`\<}
-\def\PYGZgt{\char`\>}
-\def\PYGZsh{\char`\#}
-\def\PYGZpc{\char`\%}
-\def\PYGZdl{\char`\$}
-\def\PYGZhy{\char`\-}
-\def\PYGZsq{\char`\'}
-\def\PYGZdq{\char`\"}
-\def\PYGZti{\char`\~}
-% for compatibility with earlier versions
-\def\PYGZat{@}
-\def\PYGZlb{[}
-\def\PYGZrb{]}
-\makeatother
-
-\renewcommand\PYGZsq{\textquotesingle}
-
\begin{document}
\maketitle
-\tableofcontents
-\phantomsection\label{index::doc}
+\sphinxtableofcontents
+\phantomsection\label{\detokenize{index::doc}}
\chapter{S3QL}
-\label{about::doc}\label{about:s3ql-user-s-guide}\label{about:s3ql}
+\label{\detokenize{about:s3ql}}\label{\detokenize{about::doc}}
S3QL is a file system that stores all its data online using storage
-services like \href{http://code.google.com/apis/storage/}{Google Storage}, \href{http://aws.amazon.com/s3}{Amazon S3}, or \href{http://openstack.org/projects/storage/}{OpenStack}. S3QL
+services like \sphinxhref{http://code.google.com/apis/storage/}{Google Storage}, \sphinxhref{http://aws.amazon.com/s3}{Amazon S3}, or \sphinxhref{http://openstack.org/projects/storage/}{OpenStack}. S3QL
effectively provides a hard disk of dynamic, infinite capacity that
can be accessed from any computer with internet access.
@@ -170,40 +87,40 @@ with extensive automated test cases for all its components.
\section{Features}
-\label{about:features}\label{about:openstack}\begin{itemize}
+\label{\detokenize{about:features}}\begin{itemize}
\item {}
-\textbf{Transparency.} Conceptually, S3QL is indistinguishable from a
+\sphinxstylestrong{Transparency.} Conceptually, S3QL is indistinguishable from a
local file system. For example, it supports hardlinks, symlinks,
standard unix permissions, extended attributes and file
sizes up to 2 TB.
\item {}
-\textbf{Dynamic Size.} The size of an S3QL file system grows and shrinks
+\sphinxstylestrong{Dynamic Size.} The size of an S3QL file system grows and shrinks
dynamically as required.
\item {}
-\textbf{Compression.} Before storage, all data may compressed with the
+\sphinxstylestrong{Compression.} Before storage, all data may compressed with the
LZMA, bzip2 or deflate (gzip) algorithm.
\item {}
-\textbf{Encryption.} After compression (but before upload), all data can be
+\sphinxstylestrong{Encryption.} After compression (but before upload), all data can be
AES encrypted with a 256 bit key. An additional SHA256 HMAC checksum
is used to protect the data against manipulation.
\item {}
-\textbf{Data De-duplication.} If several files have identical contents,
+\sphinxstylestrong{Data De-duplication.} If several files have identical contents,
the redundant data will be stored only once. This works across all
files stored in the file system, and also if only some parts of the
files are identical while other parts differ.
\item {}
-\textbf{Immutable Trees.} Directory trees can be made immutable, so that
+\sphinxstylestrong{Immutable Trees.} Directory trees can be made immutable, so that
their contents can no longer be changed in any way whatsoever. This
can be used to ensure that backups can not be modified after they
have been made.
\item {}
-\textbf{Copy-on-Write/Snapshotting.} S3QL can replicate entire directory
+\sphinxstylestrong{Copy-on-Write/Snapshotting.} S3QL can replicate entire directory
trees without using any additional storage space. Only if one of the
copies is modified, the part of the data that has been modified will
take up additional storage space. This can be used to create
@@ -211,7 +128,7 @@ intelligent snapshots that preserve the state of a directory at
different points in time using a minimum amount of space.
\item {}
-\textbf{High Performance independent of network latency.} All operations
+\sphinxstylestrong{High Performance independent of network latency.} All operations
that do not write or read file contents (like creating directories
or moving, renaming, and changing permissions of files and
directories) are very fast because they are carried out without any
@@ -222,7 +139,7 @@ in a database. This database is locally cached and the remote
copy updated asynchronously.
\item {}
-\textbf{Support for low bandwidth connections.} S3QL splits file contents
+\sphinxstylestrong{Support for low bandwidth connections.} S3QL splits file contents
into smaller blocks and caches blocks locally. This minimizes both
the number of network transactions required for reading and writing
data, and the amount of data that has to be transferred when only
@@ -232,7 +149,7 @@ parts of a file are read or written.
\section{Development Status}
-\label{about:development-status}
+\label{\detokenize{about:development-status}}
S3QL is considered stable and suitable for production use. Starting
with version 2.17.1, S3QL uses semantic versioning. This means that
backwards-incompatible versions (e.g., versions that require an
@@ -241,7 +158,7 @@ of the major version number.
\section{Supported Platforms}
-\label{about:supported-platforms}
+\label{\detokenize{about:supported-platforms}}
S3QL is developed and tested under Linux. Users have also reported
running S3QL successfully on OS-X, FreeBSD and NetBSD. We try to
maintain compatibility with these systems, but (due to lack of
@@ -251,157 +168,151 @@ try to fix them.
\section{Contributing}
-\label{about:contributing}
-The S3QL source code is available both on \href{https://github.com/s3ql/main}{GitHub} and \href{https://bitbucket.org/nikratio/s3ql/}{BitBucket}.
+\label{\detokenize{about:contributing}}
+The S3QL source code is available on \sphinxhref{https://github.com/s3ql/main}{GitHub}.
\chapter{Installation}
-\label{installation:github}\label{installation::doc}\label{installation:installation}
+\label{\detokenize{installation:installation}}\label{\detokenize{installation::doc}}
S3QL depends on several other programs and libraries that have to be
installed first. The best method to satisfy these dependencies depends
on your distribution.
-The following instructions are for S3QL 2.32 and should be
-applicable to any system. The \href{https://bitbucket.org/nikratio/s3ql/wiki/Home}{S3QL Wiki} contains \href{https://bitbucket.org/nikratio/s3ql/wiki/Installation}{additional
-help} help
-for specific distributions and operating systems. Note, however, that
-S3QL wiki is editable by anyone. The information there has thus not
-been vetted by the S3QL maintainers, and may be wrong, out-of-date, or
-even dangerous. Generally, you should only follow steps from the Wiki
-that you fully understand yourself, and fall back on the instructions
-below when in doubt.
-
\section{Dependencies}
-\label{installation:dependencies}
+\label{\detokenize{installation:dependencies}}
The following is a list of the programs and libraries required for
running S3QL. Generally, you should first check if your distribution
already provides a suitable packages and only install from source if
that is not the case.
\begin{itemize}
\item {}
-Kernel: Linux 2.6.9 or newer or FreeBSD with \href{http://www.freshports.org/sysutils/fusefs-kmod/}{FUSE4BSD}. Starting with
+Kernel: Linux 2.6.9 or newer or FreeBSD with \sphinxhref{http://www.freshports.org/sysutils/fusefs-kmod/}{FUSE4BSD}. Starting with
kernel 2.6.26 you will get significantly better write performance,
-so under Linux you should actually use \emph{2.6.26 or newer whenever
+so under Linux you should actually use \sphinxstyleemphasis{2.6.26 or newer whenever
possible}.
\item {}
-The \href{http://psmisc.sf.net/}{psmisc} utilities.
+The \sphinxhref{http://psmisc.sf.net/}{psmisc} utilities.
\item {}
-\href{http://www.sqlite.org/}{SQLite} version 3.7.0 or newer. SQLite
-has to be installed as a \emph{shared library} with development headers.
+\sphinxhref{http://www.sqlite.org/}{SQLite} version 3.7.0 or newer. SQLite
+has to be installed as a \sphinxstyleemphasis{shared library} with development headers.
\item {}
-\href{http://www.python.org/}{Python} 3.5.0 or newer. Make sure to also
+\sphinxhref{http://www.python.org/}{Python} 3.5.0 or newer. Make sure to also
install the development headers.
\item {}
The following Python modules:
\begin{itemize}
\item {}
-\href{https://pypi.python.org/pypi/setuptools}{setuptools}, version 1.0 or newer.
+\sphinxhref{https://pypi.python.org/pypi/setuptools}{setuptools}, version 1.0 or newer.
\item {}
-\href{https://www.dlitz.net/software/pycrypto/}{pycrypto}
+\sphinxhref{https://www.dlitz.net/software/pycrypto/}{pycrypto}
\item {}
-\href{https://pypi.python.org/pypi/defusedxml/}{defusedxml}
+\sphinxhref{https://pypi.python.org/pypi/defusedxml/}{defusedxml}
\item {}
-\href{https://pypi.python.org/pypi/requests/}{requests} (optional,
+\sphinxhref{https://pypi.python.org/pypi/requests/}{requests} (optional,
required for OAuth2 authentication with Google Storage)
\item {}
-\href{https://github.com/systemd/python-systemd}{systemd} (optional,
-for enabling systemd support). Do \emph{not} install the module from
+\sphinxhref{https://github.com/systemd/python-systemd}{systemd} (optional,
+for enabling systemd support). Do \sphinxstyleemphasis{not} install the module from
PyPi, this is from a third-party developer and incompatible with
the official module from the systemd developers.
\item {}
-\href{https://github.com/rogerbinns/apsw}{apsw}, version 3.7.0 or
+\sphinxhref{https://github.com/rogerbinns/apsw}{apsw}, version 3.7.0 or
newer.
\item {}
-\href{https://bitbucket.org/nikratio/python-llfuse/}{llfuse}, any
+\sphinxhref{https://pypi.org/project/llfuse/}{llfuse}, any
version between 1.0 (inclusive) and 2.0 (exclusive)
\item {}
-\href{https://bitbucket.org/nikratio/python-dugong/}{dugong}, any
+\sphinxhref{https://pypi.org/project/dugong/}{dugong}, any
version between 3.4 (inclusive) and 4.0 (exclusive)
\item {}
-\href{http://pytest.org/}{pytest}, version 2.7 or newer (optional, to run unit tests)
+\sphinxhref{http://pytest.org/}{pytest}, version 2.7 or newer (optional, to run unit tests)
\end{itemize}
-To check if a specific module \sphinxcode{\textless{}module\textgreater{}} is installed, execute
-\sphinxcode{python3 -c 'import \emph{\textless{}module\textgreater{}};
-print(\emph{\textless{}module\textgreater{}}.\_\_version\_\_)'}. This will result in an
-\sphinxcode{ImportError} if the module is not installed, and will print the
+To check if a specific module \sphinxcode{\sphinxupquote{\textless{}module\textgreater{}}} is installed, execute
+\sphinxcode{\sphinxupquote{python3 -c 'import \sphinxstyleemphasis{\textless{}module\textgreater{}};
+print(\sphinxstyleemphasis{\textless{}module\textgreater{}}.\_\_version\_\_)'}}. This will result in an
+\sphinxcode{\sphinxupquote{ImportError}} if the module is not installed, and will print the
installed version if the module is installed.
\end{itemize}
\section{Installing S3QL}
-\label{installation:installing-s3ql}\label{installation:inst-s3ql}
+\label{\detokenize{installation:installing-s3ql}}\label{\detokenize{installation:inst-s3ql}}
To build and install S3QL itself, proceed as follows:
\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
\item {}
-Download S3QL from \url{https://bitbucket.org/nikratio/s3ql/downloads}
+Download S3QL from \sphinxurl{https://github.com/s3ql/s3ql/releases}
\item {}
Unpack it into a folder of your choice
\item {}
-Run \sphinxcode{python3 setup.py build\_ext -{-}inplace} to build S3QL.
+Run \sphinxcode{\sphinxupquote{python3 setup.py build\_ext -{-}inplace}} to build S3QL.
\item {}
-Run \sphinxcode{python3 -m pytest tests/} to run a self-test. If this fails, ask
-for help on the \href{http://groups.google.com/group/s3ql}{mailing list} or report a bug in the
-\href{https://bitbucket.org/nikratio/s3ql/issues}{issue tracker}.
+Run \sphinxcode{\sphinxupquote{python3 -m pytest tests/}} to run a self-test. If this fails, ask
+for help on the \sphinxhref{http://groups.google.com/group/s3ql}{mailing list} or report a bug in the
+\sphinxhref{https://github.com/s3ql/s3ql/issues}{issue tracker}.
\end{enumerate}
Now you have three options:
\begin{itemize}
\item {}
-You can run the S3QL commands from the \sphinxcode{bin/} directory.
+You can run the S3QL commands from the \sphinxcode{\sphinxupquote{bin/}} directory.
\item {}
You can install S3QL system-wide for all users. To do that, you
-have to run \sphinxcode{sudo python3 setup.py install}.
+have to run \sphinxcode{\sphinxupquote{sudo python3 setup.py install}}.
\item {}
-You can install S3QL into \sphinxcode{\textasciitilde{}/.local} by executing \sphinxcode{python3
-setup.py install -{-}user}. In this case you should make sure that
-\sphinxcode{\textasciitilde{}/.local/bin} is in your \sphinxcode{\$PATH} environment variable.
+You can install S3QL into \sphinxcode{\sphinxupquote{\textasciitilde{}/.local}} by executing \sphinxcode{\sphinxupquote{python3
+setup.py install -{-}user}}. In this case you should make sure that
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.local/bin}} is in your \sphinxcode{\sphinxupquote{\$PATH}} environment variable.
\end{itemize}
\section{Development Version}
-\label{installation:development-version}
+\label{\detokenize{installation:development-version}}
If you have checked out the unstable development version from the
-Mercurial repository, a bit more effort is required. You'll also need:
+Mercurial repository, a bit more effort is required. You’ll also need:
\begin{itemize}
\item {}
-Version 0.24 or newer of the \href{http://www.cython.org/}{Cython} compiler.
+Version 0.24 or newer of the \sphinxhref{http://www.cython.org/}{Cython} compiler.
\item {}
-Version 1.2b1 or newer of the \href{http://sphinx.pocoo.org/}{Sphinx} document processor.
+Version 1.2b1 or newer of the \sphinxhref{http://sphinx.pocoo.org/}{Sphinx} document processor.
\end{itemize}
With these additional dependencies installed, S3QL can be build and
tested with
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{python3 setup.py build\PYGZus{}cython}
\PYG{l}{python3 setup.py build\PYGZus{}ext \PYGZhy{}\PYGZhy{}inplace}
\PYG{l}{python3 \PYGZhy{}m pytest tests/}
-\end{Verbatim}
+\end{sphinxVerbatim}
Note that when building from the Mercurial or Git repository, building
and testing is done with several additional checks. This may cause
@@ -409,129 +320,137 @@ compilation and/or tests to fail even though there are no problems
with functionality. For example, any use of functions that are
scheduled for deprecation in future Python version will cause tests to
fail. If you would rather just check for functionality, you can delete
-the \sphinxcode{MANIFEST.in} file. In that case, the build system will
+the \sphinxcode{\sphinxupquote{MANIFEST.in}} file. In that case, the build system will
behave as it does for a regular release.
The HTML and PDF documentation can be generated with
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{python3 setup.py build\PYGZus{}sphinx}
-\end{Verbatim}
+\end{sphinxVerbatim}
and S3QL can be installed as usual with
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{python3 setup.py install }\PYG{g+ge}{[\PYGZhy{}\PYGZhy{}user]}
-\end{Verbatim}
+\end{sphinxVerbatim}
\section{Running tests requiring remote servers}
-\label{installation:running-tests-requiring-remote-servers}
+\label{\detokenize{installation:running-tests-requiring-remote-servers}}
By default, tests requiring a connection to a remote storage backend
are skipped. If you would like to run these tests too (which is always
a good idea), you have to create additional entries in your
-\sphinxcode{\textasciitilde{}/.s3ql/authinfo2} file that tell S3QL what server and credentials to
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2}} file that tell S3QL what server and credentials to
use for these tests. These entries have the following form:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{g+ge}{[\PYGZlt{}BACKEND\PYGZgt{}\PYGZhy{}test]}
\PYG{l}{backend\PYGZhy{}login: }\PYG{n+nv}{\PYGZlt{}user\PYGZgt{}}
\PYG{l}{backend\PYGZhy{}password: }\PYG{n+nv}{\PYGZlt{}password\PYGZgt{}}
\PYG{l}{test\PYGZhy{}fs: }\PYG{n+nv}{\PYGZlt{}storage\PYGZhy{}url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
-Here \emph{\textless{}BACKEND\textgreater{}} specifies the backend that you want to test
-(e.g. \emph{s3}, \emph{s3c}, \emph{gs}, or \emph{swift}), \emph{\textless{}user\textgreater{}} and \emph{\textless{}password\textgreater{}} are
-the backend authentication credentials, and \emph{\textless{}storage-url\textgreater{}} specifies
-the full storage URL that will be used for testing. \textbf{Any existing
+Here \sphinxstyleemphasis{\textless{}BACKEND\textgreater{}} specifies the backend that you want to test
+(e.g. \sphinxstyleemphasis{s3}, \sphinxstyleemphasis{s3c}, \sphinxstyleemphasis{gs}, or \sphinxstyleemphasis{swift}), \sphinxstyleemphasis{\textless{}user\textgreater{}} and \sphinxstyleemphasis{\textless{}password\textgreater{}} are
+the backend authentication credentials, and \sphinxstyleemphasis{\textless{}storage-url\textgreater{}} specifies
+the full storage URL that will be used for testing. \sphinxstylestrong{Any existing
S3QL file system in this storage URL will be destroyed during
testing}.
For example, to run tests that need connection to a Google Storage
server, you would add something like
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{g+ge}{[gs\PYGZhy{}test]}
\PYG{l}{backend\PYGZhy{}login: GOOGIGWLONT238MD7HZ4}
\PYG{l}{backend\PYGZhy{}password: rmEbstjscoeunt1249oes1298gauidbs3hl}
\PYG{l}{test\PYGZhy{}fs: gs://joes\PYGZhy{}gs\PYGZhy{}bucket/s3ql\PYGZus{}tests/}
-\end{Verbatim}
+\end{sphinxVerbatim}
-On the next run of \sphinxcode{runtest.py} (or \sphinxcode{py.test} when using the
+On the next run of \sphinxcode{\sphinxupquote{runtest.py}} (or \sphinxcode{\sphinxupquote{py.test}} when using the
development version), the additional tests will be run. If the tests
are still skipped, you can get more information about why tests are
-being skipped by passing the \sphinxcode{-rs} argument to
-\sphinxcode{runtest.py}/\sphinxcode{py.test}.
+being skipped by passing the \sphinxcode{\sphinxupquote{-rs}} argument to
+\sphinxcode{\sphinxupquote{runtest.py}}/\sphinxcode{\sphinxupquote{py.test}}.
\chapter{Storage Backends}
-\label{backends:sphinx}\label{backends::doc}\label{backends:storage-backends}\label{backends:id1}
-S3QL supports different \emph{backends} to store data at different service
-providers and using different protocols. A \emph{storage url} specifies a
+\label{\detokenize{backends:storage-backends}}\label{\detokenize{backends:id1}}\label{\detokenize{backends::doc}}
+S3QL supports different \sphinxstyleemphasis{backends} to store data at different service
+providers and using different protocols. A \sphinxstyleemphasis{storage url} specifies a
backend together with some backend-specific information and uniquely
identifies an S3QL file system. The form of the storage url depends on
the backend and is described for every backend below.
Furthermore, every S3QL commands that accepts a storage url also
-accepts a \sphinxcode{-{-}backend-options} parameter than can be used to
+accepts a \sphinxcode{\sphinxupquote{-{-}backend-options}} parameter than can be used to
pass backend-specific options to the backend module. The available
options are documented with the respective backends below.
-All storage backends respect the \sphinxcode{http\_proxy} (for plain HTTP
-connections) and \sphinxcode{https\_proxy} (for SSL connections)
+All storage backends respect the \sphinxcode{\sphinxupquote{http\_proxy}} (for plain HTTP
+connections) and \sphinxcode{\sphinxupquote{https\_proxy}} (for SSL connections)
environment variables.
-\begin{notice}{note}{Note:}
-Storage backends are not necessarily compatible. Don't expect that
+\begin{sphinxadmonition}{note}{Note:}
+Storage backends are not necessarily compatible. Don’t expect that
you can e.g. copy the data stored by the local backend into Amazon
-S3 using some non-S3QL tool and then access it with S3QL's S3
+S3 using some non-S3QL tool and then access it with S3QL’s S3
backend. If you want to copy file systems from one backend to
-another, you need to use the \sphinxcode{clone\_fs.py} script (from the
-\sphinxcode{contrib} directory in the S3QL tarball).
-\end{notice}
+another, you need to use the \sphinxcode{\sphinxupquote{clone\_fs.py}} script (from the
+\sphinxcode{\sphinxupquote{contrib}} directory in the S3QL tarball).
+\end{sphinxadmonition}
\section{Google Storage}
-\label{backends:google-storage}
-\href{http://code.google.com/apis/storage/}{Google Storage} is an online
+\label{\detokenize{backends:google-storage}}
+\sphinxhref{http://code.google.com/apis/storage/}{Google Storage} is an online
storage service offered by Google. To use the Google Storage backend,
-you need to have (or sign up for) a Google account, and then \href{http://code.google.com/apis/storage/docs/signup.html}{activate
+you need to have (or sign up for) a Google account, and then \sphinxhref{http://code.google.com/apis/storage/docs/signup.html}{activate
Google Storage}
for your account. The account is free, you will pay only for the
amount of storage and traffic that you actually use. There are two
ways to access Google storage:
\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
\item {}
-Use S3-like authentication. To do this, first \href{https://developers.google.com/storage/docs/migrating\#defaultproj}{set a default
+Use S3-like authentication. To do this, first \sphinxhref{https://developers.google.com/storage/docs/migrating\#defaultproj}{set a default
project}.
-Then use the \href{https://code.google.com/apis/console/\#:storage:legacy}{key management tool} to
-retrieve your \emph{Google Storage developer access key} and \emph{Google
+Then use the \sphinxhref{https://code.google.com/apis/console/\#:storage:legacy}{key management tool} to
+retrieve your \sphinxstyleemphasis{Google Storage developer access key} and \sphinxstyleemphasis{Google
Storage developer secret} and use that as backend login and backend
password.
\item {}
-Use OAuth2 authentication. In this case you need to use \sphinxcode{oauth2}
+Use OAuth2 authentication. In this case you need to use \sphinxcode{\sphinxupquote{oauth2}}
as the backend login, and a valid OAuth2 refresh token as the
backend password. To obtain a refresh token, you can use the
-{\hyperref[man/oauth_client:oauth\string-client]{\sphinxcrossref{\DUrole{std,std-ref}{s3ql\_oauth\_client}}}} program. It will instruct
+{\hyperref[\detokenize{man/oauth_client:oauth-client}]{\sphinxcrossref{\DUrole{std,std-ref}{s3ql\_oauth\_client}}}} program. It will instruct
you to open a specific URL in your browser, enter a code and
authenticate with your Google account. Once this procedure is
-complete, {\hyperref[man/oauth_client:oauth\string-client]{\sphinxcrossref{\DUrole{std,std-ref}{s3ql\_oauth\_client}}}} will print out
+complete, {\hyperref[\detokenize{man/oauth_client:oauth-client}]{\sphinxcrossref{\DUrole{std,std-ref}{s3ql\_oauth\_client}}}} will print out
the refresh token. Note that you need to do this procedure only
once, the refresh token will remain valid until you explicitly
revoke it.
\end{enumerate}
-To create a Google Storage bucket, you can use e.g. the \href{https://sandbox.google.com/storage/}{Google
+To create a Google Storage bucket, you can use e.g. the \sphinxhref{https://sandbox.google.com/storage/}{Google
Storage Manager}. The storage URL for accessing the bucket in S3QL is
then
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{gs://}\PYG{n+nv}{\PYGZlt{}bucketname\PYGZgt{}}\PYG{l}{/}\PYG{n+nv}{\PYGZlt{}prefix\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
-Here \emph{bucketname} is the name of the bucket, and \emph{prefix} can be an
+Here \sphinxstyleemphasis{bucketname} is the name of the bucket, and \sphinxstyleemphasis{prefix} can be an
arbitrary prefix that will be prepended to all object names used by
S3QL. This allows you to store several S3QL file systems in the same
Google Storage bucket.
@@ -540,7 +459,7 @@ The Google Storage backend accepts the following backend options:
\index{gs\_backend command line option!no-ssl}\index{no-ssl!gs\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-gs_backend-arg-no-ssl}\pysigline{\sphinxbfcode{no-ssl}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-gs-backend-arg-no-ssl}}\pysigline{\sphinxbfcode{\sphinxupquote{no-ssl}}\sphinxcode{\sphinxupquote{}}}
Disable encrypted (https) connections and use plain HTTP instead.
\end{fulllineitems}
@@ -548,10 +467,10 @@ Disable encrypted (https) connections and use plain HTTP instead.
\index{gs\_backend command line option!ssl-ca-path=\textless{}path\textgreater{}}\index{ssl-ca-path=\textless{}path\textgreater{}!gs\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-gs_backend-arg-ssl-ca-path}\pysigline{\sphinxbfcode{ssl-ca-path}\sphinxcode{=\textless{}path\textgreater{}}}
-Instead of using the system's default certificate store, validate
+\phantomsection\label{\detokenize{backends:cmdoption-gs-backend-arg-ssl-ca-path}}\pysigline{\sphinxbfcode{\sphinxupquote{ssl-ca-path}}\sphinxcode{\sphinxupquote{=\textless{}path\textgreater{}}}}
+Instead of using the system’s default certificate store, validate
the server certificate against the specified CA
-certificates. \sphinxcode{\textless{}path\textgreater{}} may be either a file containing
+certificates. \sphinxcode{\sphinxupquote{\textless{}path\textgreater{}}} may be either a file containing
multiple certificates, or a directory containing one certificate
per file.
@@ -560,7 +479,7 @@ per file.
\index{gs\_backend command line option!tcp-timeout}\index{tcp-timeout!gs\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-gs_backend-arg-tcp-timeout}\pysigline{\sphinxbfcode{tcp-timeout}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-gs-backend-arg-tcp-timeout}}\pysigline{\sphinxbfcode{\sphinxupquote{tcp-timeout}}\sphinxcode{\sphinxupquote{}}}
Specifies the timeout used for TCP connections. If no data can be
exchanged with the remote server for longer than this period, the
TCP connection is closed and re-established (default: 20 seconds).
@@ -570,46 +489,48 @@ TCP connection is closed and re-established (default: 20 seconds).
\section{Amazon S3}
-\label{backends:amazon-s3}\label{backends:google-storage-manager}
-\href{http://aws.amazon.com/s3}{Amazon S3} is the online storage service
-offered by \href{http://aws.amazon.com/}{Amazon Web Services (AWS)}. To
+\label{\detokenize{backends:amazon-s3}}
+\sphinxhref{http://aws.amazon.com/s3}{Amazon S3} is the online storage service
+offered by \sphinxhref{http://aws.amazon.com/}{Amazon Web Services (AWS)}. To
use the S3 backend, you first need to sign up for an AWS account. The
account is free, you will pay only for the amount of storage and
traffic that you actually use. After that, you need to create a bucket
-that will hold the S3QL file system, e.g. using the \href{https://console.aws.amazon.com/s3/home}{AWS Management
+that will hold the S3QL file system, e.g. using the \sphinxhref{https://console.aws.amazon.com/s3/home}{AWS Management
Console}. For best
performance, it is recommend to create the bucket in the
geographically closest storage region, but not the US Standard region
-(see {\hyperref[durability:durability]{\sphinxcrossref{\DUrole{std,std-ref}{Important Rules to Avoid Losing Data}}}} for the reason).
+(see {\hyperref[\detokenize{durability:durability}]{\sphinxcrossref{\DUrole{std,std-ref}{Important Rules to Avoid Losing Data}}}} for the reason).
The storage URL for accessing S3 buckets in S3QL has the form
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3://}\PYG{n+nv}{\PYGZlt{}region\PYGZgt{}}\PYG{l}{/}\PYG{n+nv}{\PYGZlt{}bucket\PYGZgt{}}\PYG{l}{/}\PYG{n+nv}{\PYGZlt{}prefix\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
-\emph{prefix} can be an arbitrary prefix that will be prepended to all
+\sphinxstyleemphasis{prefix} can be an arbitrary prefix that will be prepended to all
object names used by S3QL. This allows you to store several S3QL file
systems in the same S3 bucket. For example, the storage URL
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3://ap\PYGZhy{}south\PYGZhy{}1/foomart.net/data/s3ql\PYGZus{}backup/}
-\end{Verbatim}
+\end{sphinxVerbatim}
-refers to the \emph{foomart.net} bucket in the \emph{ap-south-1} region. All
+refers to the \sphinxstyleemphasis{foomart.net} bucket in the \sphinxstyleemphasis{ap-south-1} region. All
storage objects that S3QL stores in this bucket will be prefixed with
-\emph{data/s3ql\_backup/}.
+\sphinxstyleemphasis{data/s3ql\_backup/}.
Note that the backend login and password for accessing S3 are not the
user id and password that you use to log into the Amazon Webpage, but
-the \emph{AWS access key id} and \emph{AWS secret access key} shown under \href{https://aws-portal.amazon.com/gp/aws/developer/account/index.html?ie=UTF8\&action=access-key}{My
+the \sphinxstyleemphasis{AWS access key id} and \sphinxstyleemphasis{AWS secret access key} shown under \sphinxhref{https://aws-portal.amazon.com/gp/aws/developer/account/index.html?ie=UTF8\&action=access-key}{My
Account/Access Identifiers}.
The Amazon S3 backend accepts the following backend options:
\index{s3\_backend command line option!no-ssl}\index{no-ssl!s3\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3_backend-arg-no-ssl}\pysigline{\sphinxbfcode{no-ssl}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-no-ssl}}\pysigline{\sphinxbfcode{\sphinxupquote{no-ssl}}\sphinxcode{\sphinxupquote{}}}
Disable encrypted (https) connections and use plain HTTP instead.
\end{fulllineitems}
@@ -617,10 +538,10 @@ Disable encrypted (https) connections and use plain HTTP instead.
\index{s3\_backend command line option!ssl-ca-path=\textless{}path\textgreater{}}\index{ssl-ca-path=\textless{}path\textgreater{}!s3\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3_backend-arg-ssl-ca-path}\pysigline{\sphinxbfcode{ssl-ca-path}\sphinxcode{=\textless{}path\textgreater{}}}
-Instead of using the system's default certificate store, validate
+\phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-ssl-ca-path}}\pysigline{\sphinxbfcode{\sphinxupquote{ssl-ca-path}}\sphinxcode{\sphinxupquote{=\textless{}path\textgreater{}}}}
+Instead of using the system’s default certificate store, validate
the server certificate against the specified CA
-certificates. \sphinxcode{\textless{}path\textgreater{}} may be either a file containing
+certificates. \sphinxcode{\sphinxupquote{\textless{}path\textgreater{}}} may be either a file containing
multiple certificates, or a directory containing one certificate
per file.
@@ -629,7 +550,7 @@ per file.
\index{s3\_backend command line option!tcp-timeout}\index{tcp-timeout!s3\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3_backend-arg-tcp-timeout}\pysigline{\sphinxbfcode{tcp-timeout}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-tcp-timeout}}\pysigline{\sphinxbfcode{\sphinxupquote{tcp-timeout}}\sphinxcode{\sphinxupquote{}}}
Specifies the timeout used for TCP connections. If no data can be
exchanged with the remote server for longer than this period, the
TCP connection is closed and re-established (default: 20 seconds).
@@ -639,17 +560,17 @@ TCP connection is closed and re-established (default: 20 seconds).
\index{s3\_backend command line option!sse}\index{sse!s3\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3_backend-arg-sse}\pysigline{\sphinxbfcode{sse}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-sse}}\pysigline{\sphinxbfcode{\sphinxupquote{sse}}\sphinxcode{\sphinxupquote{}}}
Enable server side encryption. Both costs \& benefits of S3 server
side encryption are probably rather small, and this option does
-\emph{not} affect any client side encryption performed by S3QL itself.
+\sphinxstyleemphasis{not} affect any client side encryption performed by S3QL itself.
\end{fulllineitems}
\index{s3\_backend command line option!ia}\index{ia!s3\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3_backend-arg-ia}\pysigline{\sphinxbfcode{ia}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-ia}}\pysigline{\sphinxbfcode{\sphinxupquote{ia}}\sphinxcode{\sphinxupquote{}}}
Use infrequent access storage class for new objects.
\end{fulllineitems}
@@ -657,23 +578,23 @@ Use infrequent access storage class for new objects.
\index{s3\_backend command line option!rrs}\index{rrs!s3\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3_backend-arg-rrs}\pysigline{\sphinxbfcode{rrs}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-rrs}}\pysigline{\sphinxbfcode{\sphinxupquote{rrs}}\sphinxcode{\sphinxupquote{}}}
Enable reduced redundancy storage for newly created objects
-(overwrites the \emph{ia} option).
+(overwrites the \sphinxstyleemphasis{ia} option).
When enabling this option, it is strongly recommended to
-periodically run {\hyperref[fsck:s3ql\string-verify]{\sphinxcrossref{\DUrole{std,std-ref}{s3ql\_verify}}}}, because objects
+periodically run {\hyperref[\detokenize{fsck:s3ql-verify}]{\sphinxcrossref{\DUrole{std,std-ref}{s3ql\_verify}}}}, because objects
that are lost by the storage backend may cause subsequent data loss
even later in time due to the data de-duplication feature of S3QL (see
-{\hyperref[durability:backend\string-reliability]{\sphinxcrossref{\DUrole{std,std-ref}{Data Durability}}}} for details).
+{\hyperref[\detokenize{durability:backend-reliability}]{\sphinxcrossref{\DUrole{std,std-ref}{Data Durability}}}} for details).
\end{fulllineitems}
\section{OpenStack/Swift}
-\label{backends:openstack-swift}\label{backends:openstack-backend}
-\href{http://www.openstack.org/}{OpenStack} is an open-source cloud server application suite. \href{http://openstack.org/projects/storage/}{Swift} is
+\label{\detokenize{backends:openstack-swift}}\label{\detokenize{backends:openstack-backend}}
+\sphinxhref{http://www.openstack.org/}{OpenStack} is an open-source cloud server application suite. \sphinxhref{http://openstack.org/projects/storage/}{Swift} is
the cloud storage module of OpenStack. Swift/OpenStack storage is
offered by many different companies.
@@ -681,23 +602,25 @@ There are two different storage URL for the OpenStack backend that
make use of different authentication APIs. For legacy (v1)
authentication, the storage URL is
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{swift://}\PYG{n+nv}{\PYGZlt{}hostname\PYGZgt{}}\PYG{g+ge}{[:\PYGZlt{}port\PYGZgt{}]}\PYG{l}{/}\PYG{n+nv}{\PYGZlt{}container\PYGZgt{}}\PYG{g+ge}{[/\PYGZlt{}prefix\PYGZgt{}]}
-\end{Verbatim}
+\end{sphinxVerbatim}
for Keystone (v2) authentication, the storage URL is
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{swiftks://}\PYG{n+nv}{\PYGZlt{}hostname\PYGZgt{}}\PYG{g+ge}{[:\PYGZlt{}port\PYGZgt{}]}\PYG{l}{/}\PYG{n+nv}{\PYGZlt{}region\PYGZgt{}}\PYG{l}{:}\PYG{n+nv}{\PYGZlt{}container\PYGZgt{}}\PYG{g+ge}{[/\PYGZlt{}prefix\PYGZgt{}]}
-\end{Verbatim}
+\end{sphinxVerbatim}
Note that when using Keystone authentication, you can (and have to)
specify the storage region of the container as well.
-In both cases, \emph{hostname} name should be the name of the
+In both cases, \sphinxstyleemphasis{hostname} name should be the name of the
authentication server. The storage container must already exist (most
OpenStack providers offer either a web frontend or a command line tool
-for creating containers). \emph{prefix} can be an arbitrary prefix that
+for creating containers). \sphinxstyleemphasis{prefix} can be an arbitrary prefix that
will be prepended to all object names used by S3QL, which can be used
to store multiple S3QL file systems in the same container.
@@ -705,7 +628,7 @@ When using legacy authentication, the backend login and password
correspond to the OpenStack username and API Access Key. When using
Keystone authentication, the backend password is your regular
OpenStack password and the backend login combines you OpenStack
-username and tenant name in the form \sphinxcode{\textless{}tenant\textgreater{}:\textless{}user\textgreater{}}. If no tenant
+username and tenant name in the form \sphinxcode{\sphinxupquote{\textless{}tenant\textgreater{}:\textless{}user\textgreater{}}}. If no tenant
is required, the OpenStack username alone may be used as backend
login.
@@ -713,7 +636,7 @@ The OpenStack backend accepts the following backend options:
\index{swift\_backend command line option!no-ssl}\index{no-ssl!swift\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-swift_backend-arg-no-ssl}\pysigline{\sphinxbfcode{no-ssl}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-no-ssl}}\pysigline{\sphinxbfcode{\sphinxupquote{no-ssl}}\sphinxcode{\sphinxupquote{}}}
Use plain HTTP to connect to the authentication server. This option
does not directly affect the connection to the storage
server. Whether HTTPS or plain HTTP is used to connect to the
@@ -724,10 +647,10 @@ storage server is determined by the authentication server.
\index{swift\_backend command line option!ssl-ca-path=\textless{}path\textgreater{}}\index{ssl-ca-path=\textless{}path\textgreater{}!swift\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-swift_backend-arg-ssl-ca-path}\pysigline{\sphinxbfcode{ssl-ca-path}\sphinxcode{=\textless{}path\textgreater{}}}
-Instead of using the system's default certificate store, validate
+\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-ssl-ca-path}}\pysigline{\sphinxbfcode{\sphinxupquote{ssl-ca-path}}\sphinxcode{\sphinxupquote{=\textless{}path\textgreater{}}}}
+Instead of using the system’s default certificate store, validate
the server certificate against the specified CA
-certificates. \sphinxcode{\textless{}path\textgreater{}} may be either a file containing
+certificates. \sphinxcode{\sphinxupquote{\textless{}path\textgreater{}}} may be either a file containing
multiple certificates, or a directory containing one certificate
per file.
@@ -736,7 +659,7 @@ per file.
\index{swift\_backend command line option!tcp-timeout}\index{tcp-timeout!swift\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-swift_backend-arg-tcp-timeout}\pysigline{\sphinxbfcode{tcp-timeout}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-tcp-timeout}}\pysigline{\sphinxbfcode{\sphinxupquote{tcp-timeout}}\sphinxcode{\sphinxupquote{}}}
Specifies the timeout used for TCP connections. If no data can be
exchanged with the remote server for longer than this period, the
TCP connection is closed and re-established (default: 20 seconds).
@@ -746,11 +669,11 @@ TCP connection is closed and re-established (default: 20 seconds).
\index{swift\_backend command line option!disable-expect100}\index{disable-expect100!swift\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-swift_backend-arg-disable-expect100}\pysigline{\sphinxbfcode{disable-expect100}\sphinxcode{}}
-If this option is specified, S3QL does not use the \sphinxcode{Expect:
-continue} header (cf. \href{http://tools.ietf.org/html/rfc2616\#section-8.2.3}{RFC2616, section 8.2.3}) when uploading
+\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-disable-expect100}}\pysigline{\sphinxbfcode{\sphinxupquote{disable-expect100}}\sphinxcode{\sphinxupquote{}}}
+If this option is specified, S3QL does not use the \sphinxcode{\sphinxupquote{Expect:
+continue}} header (cf. \sphinxhref{http://tools.ietf.org/html/rfc2616\#section-8.2.3}{RFC2616, section 8.2.3}) when uploading
data to the server. This can be used to work around broken storage
-servers that don't fully support HTTP 1.1, but may decrease
+servers that don’t fully support HTTP 1.1, but may decrease
performance as object data will be transmitted to the server more
than once in some circumstances.
@@ -759,7 +682,7 @@ than once in some circumstances.
\index{swift\_backend command line option!no-feature-detection}\index{no-feature-detection!swift\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-swift_backend-arg-no-feature-detection}\pysigline{\sphinxbfcode{no-feature-detection}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-no-feature-detection}}\pysigline{\sphinxbfcode{\sphinxupquote{no-feature-detection}}\sphinxcode{\sphinxupquote{}}}
If this option is specified, S3QL does not try to dynamically detect
advanced features of the Swift backend. In this case S3QL can only
use the least common denominator of supported Swift versions and
@@ -768,51 +691,53 @@ configurations.
\end{fulllineitems}
-\begin{notice}{note}{Note:}
+\begin{sphinxadmonition}{note}{Note:}
The Swift API unfortunately lacks a number of features that S3QL
normally makes use of. S3QL works around these deficiencies as much
as possible. However, this means that storing data using the Swift
backend generally requires more network round-trips and transfer
volume than the other backends. Also, S3QL requires Swift storage
servers to provide immediate consistency for newly created objects.
-\end{notice}
+\end{sphinxadmonition}
\section{Rackspace CloudFiles}
-\label{backends:rackspace-cloudfiles}
-\href{http://www.rackspace.com/}{Rackspace} CloudFiles uses \href{http://www.openstack.org/}{OpenStack} internally, so it is possible to
+\label{\detokenize{backends:rackspace-cloudfiles}}
+\sphinxhref{http://www.rackspace.com/}{Rackspace} CloudFiles uses \sphinxhref{http://www.openstack.org/}{OpenStack} internally, so it is possible to
just use the OpenStack/Swift backend (see above) with
-\sphinxcode{auth.api.rackspacecloud.com} as the host name. For convenince,
-there is also a special \sphinxcode{rackspace} backend that uses a storage URL
+\sphinxcode{\sphinxupquote{auth.api.rackspacecloud.com}} as the host name. For convenince,
+there is also a special \sphinxcode{\sphinxupquote{rackspace}} backend that uses a storage URL
of the form
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{rackspace://}\PYG{n+nv}{\PYGZlt{}region\PYGZgt{}}\PYG{l}{/}\PYG{n+nv}{\PYGZlt{}container\PYGZgt{}}\PYG{g+ge}{[/\PYGZlt{}prefix\PYGZgt{}]}
-\end{Verbatim}
+\end{sphinxVerbatim}
The storage container must already exist in the selected
-region. \emph{prefix} can be an arbitrary prefix that will be prepended to
+region. \sphinxstyleemphasis{prefix} can be an arbitrary prefix that will be prepended to
all object names used by S3QL and can be used to store several S3QL
file systems in the same container.
-You can create a storage container for S3QL using the \href{https://mycloud.rackspace.com/}{Cloud Control
-Panel} (click on \emph{Files} in the
+You can create a storage container for S3QL using the \sphinxhref{https://mycloud.rackspace.com/}{Cloud Control
+Panel} (click on \sphinxstyleemphasis{Files} in the
topmost menu bar).
The Rackspace backend accepts the same backend options as the
-{\hyperref[backends:openstack\string-backend]{\sphinxcrossref{\DUrole{std,std-ref}{OpenStack backend}}}}.
+{\hyperref[\detokenize{backends:openstack-backend}]{\sphinxcrossref{\DUrole{std,std-ref}{OpenStack backend}}}}.
\section{S3 compatible}
-\label{backends:s3-compatible}\label{backends:rackspace}
+\label{\detokenize{backends:s3-compatible}}
The S3 compatible backend allows S3QL to access any storage service
that uses the same protocol as Amazon S3. The storage URL has the form
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3c://}\PYG{n+nv}{\PYGZlt{}hostname\PYGZgt{}}\PYG{l}{:}\PYG{n+nv}{\PYGZlt{}port\PYGZgt{}}\PYG{l}{/}\PYG{n+nv}{\PYGZlt{}bucketname\PYGZgt{}}\PYG{l}{/}\PYG{n+nv}{\PYGZlt{}prefix\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
-Here \emph{bucketname} is the name of an (existing) bucket, and \emph{prefix}
+Here \sphinxstyleemphasis{bucketname} is the name of an (existing) bucket, and \sphinxstyleemphasis{prefix}
can be an arbitrary prefix that will be prepended to all object names
used by S3QL. This allows you to store several S3QL file systems in
the same bucket.
@@ -821,7 +746,7 @@ The S3 compatible backend accepts the following backend options:
\index{s3c\_backend command line option!no-ssl}\index{no-ssl!s3c\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3c_backend-arg-no-ssl}\pysigline{\sphinxbfcode{no-ssl}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-no-ssl}}\pysigline{\sphinxbfcode{\sphinxupquote{no-ssl}}\sphinxcode{\sphinxupquote{}}}
Disable encrypted (https) connections and use plain HTTP instead.
\end{fulllineitems}
@@ -829,10 +754,10 @@ Disable encrypted (https) connections and use plain HTTP instead.
\index{s3c\_backend command line option!ssl-ca-path=\textless{}path\textgreater{}}\index{ssl-ca-path=\textless{}path\textgreater{}!s3c\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3c_backend-arg-ssl-ca-path}\pysigline{\sphinxbfcode{ssl-ca-path}\sphinxcode{=\textless{}path\textgreater{}}}
-Instead of using the system's default certificate store, validate
+\phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-ssl-ca-path}}\pysigline{\sphinxbfcode{\sphinxupquote{ssl-ca-path}}\sphinxcode{\sphinxupquote{=\textless{}path\textgreater{}}}}
+Instead of using the system’s default certificate store, validate
the server certificate against the specified CA
-certificates. \sphinxcode{\textless{}path\textgreater{}} may be either a file containing
+certificates. \sphinxcode{\sphinxupquote{\textless{}path\textgreater{}}} may be either a file containing
multiple certificates, or a directory containing one certificate
per file.
@@ -841,7 +766,7 @@ per file.
\index{s3c\_backend command line option!tcp-timeout}\index{tcp-timeout!s3c\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3c_backend-arg-tcp-timeout}\pysigline{\sphinxbfcode{tcp-timeout}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-tcp-timeout}}\pysigline{\sphinxbfcode{\sphinxupquote{tcp-timeout}}\sphinxcode{\sphinxupquote{}}}
Specifies the timeout used for TCP connections. If no data can be
exchanged with the remote server for longer than this period, the
TCP connection is closed and re-established (default: 20 seconds).
@@ -851,11 +776,11 @@ TCP connection is closed and re-established (default: 20 seconds).
\index{s3c\_backend command line option!disable-expect100}\index{disable-expect100!s3c\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3c_backend-arg-disable-expect100}\pysigline{\sphinxbfcode{disable-expect100}\sphinxcode{}}
-If this option is specified, S3QL does not use the \sphinxcode{Expect:
-continue} header (cf. \href{http://tools.ietf.org/html/rfc2616\#section-8.2.3}{RFC2616, section 8.2.3}) when uploading
+\phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-disable-expect100}}\pysigline{\sphinxbfcode{\sphinxupquote{disable-expect100}}\sphinxcode{\sphinxupquote{}}}
+If this option is specified, S3QL does not use the \sphinxcode{\sphinxupquote{Expect:
+continue}} header (cf. \sphinxhref{http://tools.ietf.org/html/rfc2616\#section-8.2.3}{RFC2616, section 8.2.3}) when uploading
data to the server. This can be used to work around broken storage
-servers that don't fully support HTTP 1.1, but may decrease
+servers that don’t fully support HTTP 1.1, but may decrease
performance as object data will be transmitted to the server more
than once in some circumstances.
@@ -864,14 +789,14 @@ than once in some circumstances.
\index{s3c\_backend command line option!dumb-copy}\index{dumb-copy!s3c\_backend command line option}
\begin{fulllineitems}
-\phantomsection\label{backends:cmdoption-s3c_backend-arg-dumb-copy}\pysigline{\sphinxbfcode{dumb-copy}\sphinxcode{}}
+\phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-dumb-copy}}\pysigline{\sphinxbfcode{\sphinxupquote{dumb-copy}}\sphinxcode{\sphinxupquote{}}}
If this option is specified, S3QL assumes that a COPY request to
the storage server has succeeded as soon as the server returns a
-\sphinxcode{200 OK} status. The \href{http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html}{S3 COPY API} specifies that the
+\sphinxcode{\sphinxupquote{200 OK}} status. The \sphinxhref{http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html}{S3 COPY API} specifies that the
storage server may still return an error in the request body (see
-the \href{https://doc.s3.amazonaws.com/proposals/copy.html}{copy proposal} for the rationale), so this
+the \sphinxhref{https://doc.s3.amazonaws.com/proposals/copy.html}{copy proposal} for the rationale), so this
option should only be used if you are certain that your storage
-server only returns \sphinxcode{200 OK} when the copy operation has been
+server only returns \sphinxcode{\sphinxupquote{200 OK}} when the copy operation has been
completely and successfully carried out. Using this option may be
neccessary if your storage server does not return a valid response
body for a successful copy operation.
@@ -881,33 +806,34 @@ body for a successful copy operation.
\section{Local}
-\label{backends:id6}\label{backends:local}
+\label{\detokenize{backends:local}}
S3QL is also able to store its data on the local file system. This can
be used to backup data on external media, or to access external
services that S3QL can not talk to directly (e.g., it is possible to
-store data over SSH by first mounting the remote system using \href{http://fuse.sourceforge.net/sshfs.html}{sshfs}
+store data over SSH by first mounting the remote system using \sphinxhref{http://fuse.sourceforge.net/sshfs.html}{sshfs}
and then using the local backend to store the data in the sshfs
mountpoint).
The storage URL for local storage is
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{local://}\PYG{n+nv}{\PYGZlt{}path\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
Note that you have to write three consecutive slashes to specify an
-absolute path, e.g. \sphinxcode{local:///var/archive}. Also, relative paths will
+absolute path, e.g. \sphinxcode{\sphinxupquote{local:///var/archive}}. Also, relative paths will
automatically be converted to absolute paths before the authentication
-file (see {\hyperref[authinfo:authinfo]{\sphinxcrossref{\DUrole{std,std-ref}{Storing Backend Information}}}}) is read, i.e. if you are in the
-\sphinxcode{/home/john} directory and try to mount \sphinxcode{local://s3ql}, the
+file (see {\hyperref[\detokenize{authinfo:authinfo}]{\sphinxcrossref{\DUrole{std,std-ref}{Storing Backend Information}}}}) is read, i.e. if you are in the
+\sphinxcode{\sphinxupquote{/home/john}} directory and try to mount \sphinxcode{\sphinxupquote{local://s3ql}}, the
corresponding section in the authentication file must match the
-storage url \sphinxcode{local:///home/john/s3ql}.
+storage url \sphinxcode{\sphinxupquote{local:///home/john/s3ql}}.
The local backend does not accept any backend options.
\chapter{Important Rules to Avoid Losing Data}
-\label{durability::doc}\label{durability:sshfs}\label{durability:durability}\label{durability:important-rules-to-avoid-losing-data}
+\label{\detokenize{durability:important-rules-to-avoid-losing-data}}\label{\detokenize{durability:durability}}\label{\detokenize{durability::doc}}
Most S3QL backends store data in distributed storage systems. These
systems differ from a traditional, local hard disk in several
important ways. In order to avoid losing data, this section should be
@@ -915,9 +841,12 @@ read very carefully.
\section{Rules in a Nutshell}
-\label{durability:rules-in-a-nutshell}
+\label{\detokenize{durability:rules-in-a-nutshell}}
To avoid losing your data, obey the following rules:
\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
\item {}
Know what durability you can expect from your chosen storage
provider. The durability describes how likely it is that a stored
@@ -929,10 +858,10 @@ increase the durability).
\item {}
When choosing a backend and storage provider, keep in mind that
when using S3QL, the effective durability of the file system data
-will be reduced because of S3QL's data de-duplication feature.
+will be reduced because of S3QL’s data de-duplication feature.
\item {}
-Determine your storage service's consistency window. The
+Determine your storage service’s consistency window. The
consistency window that is important for S3QL is the smaller of the
times for which:
\begin{itemize}
@@ -946,23 +875,23 @@ storage service reporting that the object does not exist
\end{itemize}
-If \emph{one} of the above times is zero, we say that as far as S3QL is
-concerned the storage service has \emph{immediate} consistency.
+If \sphinxstyleemphasis{one} of the above times is zero, we say that as far as S3QL is
+concerned the storage service has \sphinxstyleemphasis{immediate} consistency.
-If your storage provider claims that \emph{neither} of the above can
+If your storage provider claims that \sphinxstyleemphasis{neither} of the above can
ever happen, while at the same time promising high durability, you
should choose a respectable provider instead.
\item {}
When mounting the same file system on different computers (or on
-the same computer but with different \sphinxcode{-{-}cachedir} directories),
+the same computer but with different \sphinxcode{\sphinxupquote{-{-}cachedir}} directories),
the time that passes between the first and second of invocation of
-\textbf{\texttt{mount.s3ql}} must be at least as long as your storage
-service's consistency window. If your storage service offers
+\sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} must be at least as long as your storage
+service’s consistency window. If your storage service offers
immediate consistency, you do not need to wait at all.
\item {}
-Before running \textbf{\texttt{fsck.s3ql}} or \textbf{\texttt{s3qladm}}, the file system
+Before running \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} or \sphinxstyleliteralstrong{\sphinxupquote{s3qladm}}, the file system
must have been left untouched for the length of the consistency
window. If your storage service offers immediate consistency, you
do not need to wait at all.
@@ -975,20 +904,23 @@ windows for a number of larger storage providers.
\section{Consistency Window List}
-\label{durability:consistency-window-list}
+\label{\detokenize{durability:consistency-window-list}}
The following is a list of the consistency windows (as far as S3QL is
-concerned) for a number of storage providers. This list doesn't come
+concerned) for a number of storage providers. This list doesn’t come
with any guarantees and may be outdated. If your storage provider is
not included, or if you need more reliable information, check with
your storage provider.
-\noindent\begin{tabulary}{\linewidth}{|L|L|}
+
+\begin{savenotes}\sphinxattablestart
+\centering
+\begin{tabulary}{\linewidth}[t]{|T|T|}
\hline
-\textsf{\relax
+\sphinxstyletheadfamily
Storage Provider
-\unskip}\relax &\textsf{\relax
+&\sphinxstyletheadfamily
Consistency Window
-\unskip}\relax \\
+\\
\hline
Amazon S3 in the US standard region
&
@@ -1004,14 +936,16 @@ Google Storage
&
Immediate
\\
-\hline\end{tabulary}
-
+\hline
+\end{tabulary}
+\par
+\sphinxattableend\end{savenotes}
\section{Data Consistency}
-\label{durability:data-consistency}
+\label{\detokenize{durability:data-consistency}}
In contrast to the typical hard disk, most storage providers do not
-guarantee \emph{immediate consistency} of written data. This means that:
+guarantee \sphinxstyleemphasis{immediate consistency} of written data. This means that:
\begin{itemize}
\item {}
after an object has been stored, requests to read this object may
@@ -1039,13 +973,13 @@ some old data and unmount it. If you then mount the file system again
right away on another computer, there is no guarantee that S3QL will
see any of the changes that the first S3QL process has made. At least
in theory it is therefore possible that on the second mount, S3QL does
-not see any of the changes that you have done and presents you an ``old
-version'' of the file system without them. Even worse, if you notice
+not see any of the changes that you have done and presents you an “old
+version” of the file system without them. Even worse, if you notice
the problem and unmount the file system, S3QL will upload the old
status (which S3QL necessarily has to consider as current) and thereby
permanently override the newer version (even though this change may
not become immediately visible either). S3QL uses several techniques
-to reduce the likelihood of this to happen (see {\hyperref[impl_details:impl\string-details]{\sphinxcrossref{\DUrole{std,std-ref}{Implementation Details}}}}
+to reduce the likelihood of this to happen (see {\hyperref[\detokenize{impl_details:impl-details}]{\sphinxcrossref{\DUrole{std,std-ref}{Implementation Details}}}}
for more information on this), but without support from the storage
service, the possibility cannot be eliminated completely.
@@ -1056,14 +990,14 @@ needs to be fixed or if it is only a temporary problem that will
resolve itself automatically (because there are still changes that
have not become visible yet).
-This is where the so called \emph{consistency window} comes in. The
+This is where the so called \sphinxstyleemphasis{consistency window} comes in. The
consistency window is the maximum time (after writing or deleting the
-object) for which any of the above ``outdated responses'' may be
+object) for which any of the above “outdated responses” may be
received. If the consistency window is zero, i.e. all changes are
-immediately effective, the storage service is said to have \emph{immediate
+immediately effective, the storage service is said to have \sphinxstyleemphasis{immediate
consistency}. If the window is infinite, i.e. there is no upper bound
on the time it may take for changes to become effect, the storage
-service is said to be \emph{eventually consistent}. Note that often there
+service is said to be \sphinxstyleemphasis{eventually consistent}. Note that often there
are different consistency windows for the different operations. For
example, Google Storage offers immediate consistency when reading
data, but only eventual consistency for the list of stored objects.
@@ -1090,15 +1024,15 @@ storage service reporting that the object does not exist
Unfortunately, many storage providers are hesitant to guarantee
anything but eventual consistency, i.e. the length of the consistency
window is potentially infinite. In that case you simply have to pick a
-length that you consider ``safe enough''. For example, even though
+length that you consider “safe enough”. For example, even though
Amazon is only guaranteeing eventual consistency, the ordinary
consistency window for data stored in S3 is just a few seconds, and
only in exceptional circumstances (i.e., core network outages) it may
-rise up to hours (\href{http://forums.aws.amazon.com/message.jspa?messageID=38471\#38471}{source}).
+rise up to hours (\sphinxhref{http://forums.aws.amazon.com/message.jspa?messageID=38471\#38471}{source}).
\section{Data Durability}
-\label{durability:backend-reliability}\label{durability:data-durability}
+\label{\detokenize{durability:data-durability}}\label{\detokenize{durability:backend-reliability}}
The durability of a storage service a measure of the average
probability of a storage object to become corrupted over time. The
lower the chance of data loss, the higher the durability. Storage
@@ -1120,17 +1054,20 @@ error will be returned and the mount point will become inaccessible to
ensure that the problem is noticed.
Secondly, the consequences of a data loss by the storage service can
-be significantly more severe than you may expect because of S3QL's
+be significantly more severe than you may expect because of S3QL’s
data de-duplication feature: a data loss in the storage service at
-time \emph{x} may cause data that is written \emph{after} time \emph{x} to be lost as
+time \sphinxstyleemphasis{x} may cause data that is written \sphinxstyleemphasis{after} time \sphinxstyleemphasis{x} to be lost as
well. Consider the following scenario:
\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
\item {}
You store an important file in the S3QL file system.
\item {}
The storage service loses the data blocks of this file. As long as you
-do not access the file or run \textbf{\texttt{fsck.s3ql}}, S3QL is not
+do not access the file or run \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}}, S3QL is not
aware that the data has been lost by the storage service.
\item {}
@@ -1151,29 +1088,29 @@ same data blocks that have been lost by the storage service).
\end{enumerate}
-For some storage services, \textbf{\texttt{fsck.s3ql}} can mitigate this
-effect. When \textbf{\texttt{fsck.s3ql}} runs, it asks the storage service
+For some storage services, \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} can mitigate this
+effect. When \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} runs, it asks the storage service
for a list of all stored objects. If objects are missing, it can then
mark the damaged files and prevent the problem from spreading forwards
-in time. Figuratively speaking, this establishes a ``checkpoint'': data
-loss that occurred before running \textbf{\texttt{fsck.s3ql}} can not affect
+in time. Figuratively speaking, this establishes a “checkpoint”: data
+loss that occurred before running \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} can not affect
any file system operations that are performed after the check.
-Unfortunately, many storage services only ``discover'' that objects are
+Unfortunately, many storage services only “discover” that objects are
missing or broken when the object actually needs to be retrieved. In
-this case, \textbf{\texttt{fsck.s3ql}} will not learn anything by just
+this case, \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} will not learn anything by just
querying the list of objects.
This effect can be mitigated to some degree by using the
-\textbf{\texttt{s3ql\_verify}} command in additon to
-\textbf{\texttt{fsck.s3ql}}. \textbf{\texttt{s3ql\_verify}} asks the storage service
+\sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} command in additon to
+\sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}}. \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} asks the storage service
to look up every stored object and may therefore take much longer than
-running \textbf{\texttt{fsck.s3ql}}, but can also offer a much stronger
+running \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}}, but can also offer a much stronger
assurance that no data has been lost by the storage service. To
-``recover'' from damaged storage objects in the backend, the damaged
-objects found by \textbf{\texttt{s3ql\_verify}} have to be explicitly deleted
-(so that a successive \textbf{\texttt{fsck.s3ql}} is able detect them as
+“recover” from damaged storage objects in the backend, the damaged
+objects found by \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} have to be explicitly deleted
+(so that a successive \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} is able detect them as
missing, correct the file system metadata, and move any affected files
-to \sphinxcode{lost+found}). This procedure is currently not automated, so
+to \sphinxcode{\sphinxupquote{lost+found}}). This procedure is currently not automated, so
it is generally a good idea to choose a storage service where the
expected data durability is high enough so that the possibility of a
lost object (and thus the need to run any full checks) can be
@@ -1181,29 +1118,30 @@ neglected over long periods of time.
\chapter{File System Creation}
-\label{mkfs:file-system-creation}\label{mkfs::doc}
-A S3QL file system is created with the \textbf{\texttt{mkfs.s3ql}} command. It has the
+\label{\detokenize{mkfs:file-system-creation}}\label{\detokenize{mkfs::doc}}
+A S3QL file system is created with the \sphinxstyleliteralstrong{\sphinxupquote{mkfs.s3ql}} command. It has the
following syntax:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{mkfs.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
This command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}backend-options \textless{}options\textgreater{}]
@@ -1213,7 +1151,7 @@ backend documentation for available options.
just print program version and exit
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-L \textless{}name\textgreater{}]
Filesystem label
\item [-{-}max-obj-size \textless{}size\textgreater{}]
@@ -1227,10 +1165,10 @@ Overwrite any existing data.
\end{optionlist}
\end{quote}
-Unless you have specified the \sphinxcode{-{-}plain} option,
-\textbf{\texttt{mkfs.s3ql}} will ask you to enter an encryption
-password. This password will \emph{not} be read from an authentication file
-specified with the \sphinxcode{-{-}authfile} option to prevent accidental
+Unless you have specified the \sphinxcode{\sphinxupquote{-{-}plain}} option,
+\sphinxstyleliteralstrong{\sphinxupquote{mkfs.s3ql}} will ask you to enter an encryption
+password. This password will \sphinxstyleemphasis{not} be read from an authentication file
+specified with the \sphinxcode{\sphinxupquote{-{-}authfile}} option to prevent accidental
creation of an encrypted file system.
Note that:
@@ -1239,101 +1177,103 @@ Note that:
All data that is stored under the given storage url is assumed to
managed exclusively by S3QL. Trying to manually save additional
objects (or remove or manipulate existing objects) will lead to file
-system corruption, and \textbf{\texttt{fsck.s3ql}} may delete objects that
+system corruption, and \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} may delete objects that
do not belong to the file system.
\item {}
With most storage backends, slashes in the storage url prefix do not
have special meaning. For example, the storage urls
-\sphinxcode{s3://mybucket/myprefix/} and \sphinxcode{s3://mybucket/myprefix} are
-distinct. In the first case, the prefix is \sphinxcode{myprefix/}, while in
-the second it is \sphinxcode{myprefix}.
+\sphinxcode{\sphinxupquote{s3://mybucket/myprefix/}} and \sphinxcode{\sphinxupquote{s3://mybucket/myprefix}} are
+distinct. In the first case, the prefix is \sphinxcode{\sphinxupquote{myprefix/}}, while in
+the second it is \sphinxcode{\sphinxupquote{myprefix}}.
\item {}
-S3QL file systems can not be ``stacked'', i.e. you cannot have one
-file system stored at \sphinxcode{s3://bucketname/outerprefix} and a second
-one at \sphinxcode{s3://bucketname/outerprefix/innerprefix}.
+S3QL file systems can not be “stacked”, i.e. you cannot have one
+file system stored at \sphinxcode{\sphinxupquote{s3://bucketname/outerprefix}} and a second
+one at \sphinxcode{\sphinxupquote{s3://bucketname/outerprefix/innerprefix}}.
\end{itemize}
\chapter{Managing File Systems}
-\label{adm::doc}\label{adm:managing-file-systems}
-The \sphinxcode{s3qladm} command performs various operations on \emph{unmounted} S3QL
-file systems. The file system \emph{must not be mounted} when using
-\sphinxcode{s3qladm} or things will go wrong badly.
+\label{\detokenize{adm:managing-file-systems}}\label{\detokenize{adm::doc}}
+The \sphinxcode{\sphinxupquote{s3qladm}} command performs various operations on \sphinxstyleemphasis{unmounted} S3QL
+file systems. The file system \sphinxstyleemphasis{must not be mounted} when using
+\sphinxcode{\sphinxupquote{s3qladm}} or things will go wrong badly.
The syntax is
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qladm }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}action\PYGZgt{}}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage\PYGZhy{}url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
-where \sphinxcode{action} may be either of \textbf{\texttt{passphrase}},
-\textbf{\texttt{upgrade}}, \textbf{\texttt{clear}} or \textbf{\texttt{download-metadata}}.
+where \sphinxcode{\sphinxupquote{action}} may be either of \sphinxstyleliteralstrong{\sphinxupquote{passphrase}},
+\sphinxstyleliteralstrong{\sphinxupquote{upgrade}}, \sphinxstyleliteralstrong{\sphinxupquote{clear}} or \sphinxstyleliteralstrong{\sphinxupquote{download-metadata}}.
-The \textbf{\texttt{s3qladm}} accepts the following general options, no
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qladm}} accepts the following general options, no
matter what specific action is being invoked:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}log \textless{}target\textgreater{}]
-Destination for log messages. Specify \sphinxcode{none} for
-standard output or \sphinxcode{syslog} for the system logging
+Destination for log messages. Specify \sphinxcode{\sphinxupquote{none}} for
+standard output or \sphinxcode{\sphinxupquote{syslog}} for the system logging
daemon. Anything else will be interpreted as a file
name. Log files will be rotated when they reach 1 MiB,
and at most 5 old log files will be kept. Default:
-\sphinxcode{None}
+\sphinxcode{\sphinxupquote{None}}
\item [-{-}backend-options \textless{}options\textgreater{}]
Backend specific options (separate by commas). See
backend documentation for available options.
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}version]
just print program version and exit
\end{optionlist}
\end{quote}
-Hint: run \sphinxcode{s3qladm \textless{}action\textgreater{} -{-}help} to get help on the additional arguments
+Hint: run \sphinxcode{\sphinxupquote{s3qladm \textless{}action\textgreater{} -{-}help}} to get help on the additional arguments
that the different actions take.
\section{Changing the Passphrase}
-\label{adm:changing-the-passphrase}
-To change the passphrase of a file system, use the \sphinxcode{passphrase}
+\label{\detokenize{adm:changing-the-passphrase}}
+To change the passphrase of a file system, use the \sphinxcode{\sphinxupquote{passphrase}}
subcommand:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qladm passphrase }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
That this will not actually re-encrypt all the stored data with the
-new passphrase. Rather, S3QL generates an internal ``master key'' when
+new passphrase. Rather, S3QL generates an internal “master key” when
the file system is created and uses this key to encrypt all stored
data. The user-supplied passphrase is used to encrypt/decrypt only the
master key, and can therefore be changed. This means, however, that if
a passphrase has been disclosed to someone untrusted, changing it
-afterwards will \textbf{not revoke access to people who had access to the
+afterwards will \sphinxstylestrong{not revoke access to people who had access to the
old passphrase} (because they could have decrypted the master key and
retained a copy).
\section{Upgrading the file system}
-\label{adm:upgrading-the-file-system}
+\label{\detokenize{adm:upgrading-the-file-system}}
If you have installed a new version of S3QL, it may sometimes be
necessary to upgrade the file system metadata as well. Note that in
this case the file system can no longer be accessed with older
@@ -1346,83 +1286,87 @@ file system at the same time.
To upgrade a file system from the previous to the current revision,
execute
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qladm upgrade }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\section{Deleting a file system}
-\label{adm:deleting-a-file-system}
+\label{\detokenize{adm:deleting-a-file-system}}
A file system can be deleted with:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qladm clear }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
This physically deletes all the data and file system structures.
\section{Restoring Metadata Backups}
-\label{adm:restoring-metadata-backups}
+\label{\detokenize{adm:restoring-metadata-backups}}
If the most-recent copy of the file system metadata has been damaged
irreparably, it is possible to restore one of the automatically
created backup copies.
The command
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qladm download\PYGZhy{}metadata }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
will give you a list of the available metadata backups and allow you
to download them. This will create two new files in the current
-directory, ending in \sphinxcode{.db} and \sphinxcode{.params}. To actually use the
-downloaded backup, you need to move these files into the \sphinxcode{\textasciitilde{}/.s3ql/}
-directory and run \sphinxcode{fsck.s3ql}.
+directory, ending in \sphinxcode{\sphinxupquote{.db}} and \sphinxcode{\sphinxupquote{.params}}. To actually use the
+downloaded backup, you need to move these files into the \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/}}
+directory and run \sphinxcode{\sphinxupquote{fsck.s3ql}}.
-\begin{notice}{warning}{Warning:}
+\begin{sphinxadmonition}{warning}{Warning:}
You should probably not use this functionality without having asked
-for help on the mailing list first (see {\hyperref[resources:resources]{\sphinxcrossref{\DUrole{std,std-ref}{Further Resources / Getting Help}}}}).
-\end{notice}
+for help on the mailing list first (see {\hyperref[\detokenize{resources:resources}]{\sphinxcrossref{\DUrole{std,std-ref}{Further Resources / Getting Help}}}}).
+\end{sphinxadmonition}
\chapter{Mounting}
-\label{mount::doc}\label{mount:mounting}
-A S3QL file system is mounted with the \textbf{\texttt{mount.s3ql}}
+\label{\detokenize{mount:mounting}}\label{\detokenize{mount::doc}}
+A S3QL file system is mounted with the \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}}
command. It has the following syntax:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{mount.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mountpoint\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
-\begin{notice}{note}{Note:}
-S3QL is not a network file system like \href{http://en.wikipedia.org/wiki/Network\_File\_System\_\%28protocol\%29}{NFS}
-or \href{http://en.wikipedia.org/wiki/CIFS}{CIFS}. It can only be
+\begin{sphinxadmonition}{note}{Note:}
+S3QL is not a network file system like \sphinxhref{http://en.wikipedia.org/wiki/Network\_File\_System\_\%28protocol\%29}{NFS}
+or \sphinxhref{http://en.wikipedia.org/wiki/CIFS}{CIFS}. It can only be
mounted on one computer at a time.
-\end{notice}
+\end{sphinxadmonition}
This command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}log \textless{}target\textgreater{}]
-Destination for log messages. Specify \sphinxcode{none} for
-standard output or \sphinxcode{syslog} for the system logging
+Destination for log messages. Specify \sphinxcode{\sphinxupquote{none}} for
+standard output or \sphinxcode{\sphinxupquote{syslog}} for the system logging
daemon. Anything else will be interpreted as a file
name. Log files will be rotated when they reach 1 MiB,
and at most 5 old log files will be kept. Default:
-\sphinxcode{\textasciitilde{}/.s3ql/mount.log}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/mount.log}}
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}backend-options \textless{}options\textgreater{}]
@@ -1432,7 +1376,7 @@ backend documentation for available options.
just print program version and exit
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-{-}cachesize \textless{}size\textgreater{}]
Cache size in KiB (default: autodetect).
\item [-{-}max-cache-entries \textless{}num\textgreater{}]
@@ -1440,20 +1384,20 @@ Maximum number of entries in cache (default:
autodetect). Each cache entry requires one file
descriptor, so if you increase this number you have to
make sure that your process file descriptor limit (as
-set with \sphinxcode{ulimit -n}) is high enough (at least the
+set with \sphinxcode{\sphinxupquote{ulimit -n}}) is high enough (at least the
number of cache entries + 100).
\item [-{-}keep-cache]
Do not purge locally cached files on exit.
\item [-{-}allow-other]
-Normally, only the user who called \sphinxcode{mount.s3ql} can
+Normally, only the user who called \sphinxcode{\sphinxupquote{mount.s3ql}} can
access the mount point. This user then also has full
access to it, independent of individual file
-permissions. If the \sphinxcode{-{-}allow-other} option is
+permissions. If the \sphinxcode{\sphinxupquote{-{-}allow-other}} option is
specified, other users can access the mount point as
well and individual file permissions are taken into
account for all users.
\item [-{-}allow-root]
-Like \sphinxcode{-{-}allow-other}, but restrict access to the
+Like \sphinxcode{\sphinxupquote{-{-}allow-other}}, but restrict access to the
mounting user and the root user.
\item [-{-}fg]
Do not daemonize, stay in foreground
@@ -1462,10 +1406,10 @@ Stay in foreground and raise SIGSTOP once mountpoint
is up.
\item [-{-}compress \textless{}algorithm-lvl\textgreater{}]
Compression algorithm and compression level to use
-when storing new data. \emph{algorithm} may be any of
-\sphinxcode{lzma}, \sphinxcode{bzip2}, \sphinxcode{zlib}, or none. \emph{lvl} may be any
+when storing new data. \sphinxstyleemphasis{algorithm} may be any of
+\sphinxcode{\sphinxupquote{lzma}}, \sphinxcode{\sphinxupquote{bzip2}}, \sphinxcode{\sphinxupquote{zlib}}, or none. \sphinxstyleemphasis{lvl} may be any
integer from 0 (fastest) to 9 (slowest). Default:
-\sphinxcode{lzma-6}
+\sphinxcode{\sphinxupquote{lzma-6}}
\item [-{-}metadata-upload-interval \textless{}seconds\textgreater{}]
Interval in seconds between complete metadata uploads.
Set to 0 to disable. Default: 24h.
@@ -1480,9 +1424,9 @@ system over NFS. (default: False)
\section{Permission Checking}
-\label{mount:permission-checking}
-If the file system is mounted with neither the \sphinxcode{allow-root}
-nor \sphinxcode{allow-other} option, the mounting user has full
+\label{\detokenize{mount:permission-checking}}
+If the file system is mounted with neither the \sphinxcode{\sphinxupquote{allow-root}}
+nor \sphinxcode{\sphinxupquote{allow-other}} option, the mounting user has full
permissions on the S3QL file system (he is effectively root). If one
(or both) of the options is used, standard unix permission checks
apply, i.e. only the real root user has full access and all other
@@ -1490,7 +1434,7 @@ users (including the mounting user) are subject to permission checks.
\section{Compression Algorithms}
-\label{mount:compression-algorithms}
+\label{\detokenize{mount:compression-algorithms}}
S3QL supports three compression algorithms, LZMA, Bzip2 and zlib (with
LZMA being the default). The compression algorithm can be specified
freely whenever the file system is mounted, since it affects only the
@@ -1506,7 +1450,7 @@ should be fast enough to saturate your network connection.
To find the optimal algorithm and number of parallel compression
threads for your system, S3QL ships with a program called
-\sphinxcode{benchmark.py} in the \sphinxcode{contrib} directory. You should run this program
+\sphinxcode{\sphinxupquote{benchmark.py}} in the \sphinxcode{\sphinxupquote{contrib}} directory. You should run this program
on a file that has a size that is roughly equal to the block size of
your file system and has similar contents. It will then determine the
compression speeds for the different algorithms and the upload speeds
@@ -1514,38 +1458,38 @@ for the specified backend and recommend the best algorithm that is
fast enough to saturate your network connection.
Obviously you should make sure that there is little other system load
-when you run \sphinxcode{benchmark.py} (i.e., don't compile software or encode
+when you run \sphinxcode{\sphinxupquote{benchmark.py}} (i.e., don’t compile software or encode
videos at the same time).
\section{Notes about Caching}
-\label{mount:notes-about-caching}
+\label{\detokenize{mount:notes-about-caching}}
S3QL maintains a local cache of the file system data to speed up
access. The cache is block based, so it is possible that only parts of
a file are in the cache.
\subsection{Maximum Number of Cache Entries}
-\label{mount:maximum-number-of-cache-entries}
+\label{\detokenize{mount:maximum-number-of-cache-entries}}
The maximum size of the cache can be configured with the
-\sphinxcode{-{-}cachesize} option. In addition to that, the maximum number
+\sphinxcode{\sphinxupquote{-{-}cachesize}} option. In addition to that, the maximum number
of objects in the cache is limited by the
-\sphinxcode{-{-}max-cache-entries} option, so it is possible that the cache
+\sphinxcode{\sphinxupquote{-{-}max-cache-entries}} option, so it is possible that the cache
does not grow up to the maximum cache size because the maximum number
of cache elements has been reached. The reason for this limit is that
each cache entry requires one open file descriptor, and Linux
distributions usually limit the total number of file descriptors per
process to about a thousand.
-If you specify a value for \sphinxcode{-{-}max-cache-entries}, you should
+If you specify a value for \sphinxcode{\sphinxupquote{-{-}max-cache-entries}}, you should
therefore make sure to also configure your system to increase the
maximum number of open file handles. This can be done temporarily with
-the \textbf{\texttt{ulimit -n}} command. The method to permanently change this limit
+the \sphinxstyleliteralstrong{\sphinxupquote{ulimit -n}} command. The method to permanently change this limit
system-wide depends on your distribution.
\subsection{Cache Flushing and Expiration}
-\label{mount:cache-flushing-and-expiration}
+\label{\detokenize{mount:cache-flushing-and-expiration}}
S3QL flushes changed blocks in the cache to the backend whenever a block
has not been accessed for at least 10 seconds. Note that when a block is
flushed, it still remains in the cache.
@@ -1556,8 +1500,8 @@ recently used blocks first.
\section{NFS Support}
-\label{mount:nfs-support}
-S3QL filesystems can be exported over NFS. The \sphinxcode{-{-}nfs} option
+\label{\detokenize{mount:nfs-support}}
+S3QL filesystems can be exported over NFS. The \sphinxcode{\sphinxupquote{-{-}nfs}} option
is recommended to improve performance when NFS is used, but no harm
will occur when it is not specified.
@@ -1566,20 +1510,20 @@ means that if a client has mounted an S3QL file system over NFS, the
server may unmount and remount the S3QL filesystem (or even reboot)
without the client being affected beyond temporarily becoming
unavailable. This poses several challenges, but is supported by S3QL
-as long as no \sphinxcode{fsck.s3ql} operation is run:
+as long as no \sphinxcode{\sphinxupquote{fsck.s3ql}} operation is run:
-\begin{notice}{warning}{Warning:}
-If \sphinxcode{fsck.s3ql} modifies a file system in any way, all NFS
+\begin{sphinxadmonition}{warning}{Warning:}
+If \sphinxcode{\sphinxupquote{fsck.s3ql}} modifies a file system in any way, all NFS
clients must unmount and re-mount the NFS share before the
S3QL file system is re-mounted on the server.
-\end{notice}
+\end{sphinxadmonition}
\section{Failure Modes}
-\label{mount:failure-modes}
+\label{\detokenize{mount:failure-modes}}
Once an S3QL file system has been mounted, there is a multitude of
problems that can occur when communicating with the remote
-server. Generally, \textbf{\texttt{mount.s3ql}} always tries to keep the file
+server. Generally, \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} always tries to keep the file
system as accessible as possible under the circumstances. That means
that if network connectivity is lost, data can still be written as
long as there is space in the local cache. Attempts to read data not
@@ -1587,60 +1531,60 @@ already present in the cache, however, will block until connection is
re-established. If any sort of data corruption is detected, the file
system will switch to read-only mode. Attempting to read files that
are affected by the corruption will return an input/output error
-(\emph{errno} set to \sphinxcode{EIO}).
+(\sphinxstyleemphasis{errno} set to \sphinxcode{\sphinxupquote{EIO}}).
-In case of other unexpected or fatal problems, \textbf{\texttt{mount.s3ql}}
+In case of other unexpected or fatal problems, \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}}
terminates, but does not unmount the file system. Any attempt to
-access the mountpoint will result in a ``Transport endpoint not
-connected'' error (\emph{errno} set to \sphinxcode{ESHUTDOWN}). This ensures that a
-mountpoint whose \textbf{\texttt{mount.s3ql}} process has terminated can not
+access the mountpoint will result in a “Transport endpoint not
+connected” error (\sphinxstyleemphasis{errno} set to \sphinxcode{\sphinxupquote{ESHUTDOWN}}). This ensures that a
+mountpoint whose \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} process has terminated can not
be confused with a mountpoint containing an empty file system (which
would be fatal if e.g. the mountpoint is automatically mirrored). When
this has happened, the mountpoint can be cleared by using the
-\textbf{\texttt{fusermount}} command (provided by FUSE) with the \sphinxcode{-u}
+\sphinxstyleliteralstrong{\sphinxupquote{fusermount}} command (provided by FUSE) with the \sphinxcode{\sphinxupquote{-u}}
parameter.
-\textbf{\texttt{mount.s3ql}} will automatically try to re-establish the
+\sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} will automatically try to re-establish the
connection to the server if network connectivity is lost, and retry
sending a request when the connection is established but the remote
server signals a temporary problem. These attempts will be made at
increasing intervals for a period up to 24 hours, with retry intervals
starting at 20 ms and increasing up to 5 minutes. After 24 hours,
-\textbf{\texttt{mount.s3ql}} will give up and terminate, leaving the
+\sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} will give up and terminate, leaving the
mountpoint inaccessible as described above.
-Generally, \textbf{\texttt{mount.s3ql}} will also emit log messages for any
+Generally, \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} will also emit log messages for any
unusual conditions that it encounters. The destination for these
-messages can be set with the \sphinxcode{-{-}log} parameter. It is highly
+messages can be set with the \sphinxcode{\sphinxupquote{-{-}log}} parameter. It is highly
recommended to periodically check these logs, for example with a tool
-like \href{http://sourceforge.net/projects/logcheck/}{logcheck}. Many potential issues that \textbf{\texttt{mount.s3ql}} may
+like \sphinxhref{http://sourceforge.net/projects/logcheck/}{logcheck}. Many potential issues that \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} may
encounter do not justify restricting access to the file system, but
should nevertheless be investigated if they occur. Checking the log
messages is the only way to find out about them.
\section{Automatic Mounting}
-\label{mount:automatic-mounting}\label{mount:logcheck}
+\label{\detokenize{mount:automatic-mounting}}
If you want to mount and umount an S3QL file system automatically at
system startup and shutdown, you should do so with a dedicated S3QL
-init job (instead of using \sphinxcode{/etc/fstab}. When using systemd,
-\textbf{\texttt{mount.s3ql}} can be run as a service of type \sphinxcode{notify}.
+init job (instead of using \sphinxcode{\sphinxupquote{/etc/fstab}}. When using systemd,
+\sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} can be run as a service of type \sphinxcode{\sphinxupquote{notify}}.
-\begin{notice}{note}{Note:}
+\begin{sphinxadmonition}{note}{Note:}
In principle, it is also possible to automatically mount an S3QL
-file system with an appropriate entry in \sphinxcode{/etc/fstab}. However,
+file system with an appropriate entry in \sphinxcode{\sphinxupquote{/etc/fstab}}. However,
this is not recommended for several reasons:
\begin{itemize}
\item {}
-file systems mounted in \sphinxcode{/etc/fstab} will be unmounted with the
-\textbf{\texttt{umount}} command, so your system will not wait until all data has
+file systems mounted in \sphinxcode{\sphinxupquote{/etc/fstab}} will be unmounted with the
+\sphinxstyleliteralstrong{\sphinxupquote{umount}} command, so your system will not wait until all data has
been uploaded but shutdown (or restart) immediately (this is a
-FUSE limitation, see \href{https://bitbucket.org/nikratio/s3ql/issue/1/blocking-fusermount-and-umount}{issue \#1}).
+FUSE limitation, cf \sphinxurl{https://github.com/libfuse/libfuse/issues/1}).
\item {}
There is no way to tell the system that mounting S3QL requires a
Python interpreter to be available, so it may attempt to run
-\textbf{\texttt{mount.s3ql}} before it has mounted the volume containing
+\sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} before it has mounted the volume containing
the Python interpreter.
\item {}
@@ -1649,55 +1593,56 @@ connection has to be up before the S3QL file system can be
mounted.
\end{itemize}
-\end{notice}
+\end{sphinxadmonition}
\chapter{Advanced S3QL Features}
-\label{special:advanced-s3ql-features}\label{special::doc}
+\label{\detokenize{special:advanced-s3ql-features}}\label{\detokenize{special::doc}}
\section{Snapshotting and Copy-on-Write}
-\label{special:snapshotting-and-copy-on-write}\label{special:s3qlcp}
-The command \sphinxcode{s3qlcp} can be used to duplicate a directory tree without
+\label{\detokenize{special:snapshotting-and-copy-on-write}}\label{\detokenize{special:s3qlcp}}
+The command \sphinxcode{\sphinxupquote{s3qlcp}} can be used to duplicate a directory tree without
physically copying the file contents. This is made possible by the
data de-duplication feature of S3QL.
-The syntax of \sphinxcode{s3qlcp} is:
+The syntax of \sphinxcode{\sphinxupquote{s3qlcp}} is:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qlcp }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}src\PYGZgt{}}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}target\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
-This will replicate the contents of the directory \sphinxcode{\textless{}src\textgreater{}} in the
-directory \sphinxcode{\textless{}target\textgreater{}}. \sphinxcode{\textless{}src\textgreater{}} has to be an existing directory and
-\sphinxcode{\textless{}target\textgreater{}} must not exist. Moreover, both directories have to be
+This will replicate the contents of the directory \sphinxcode{\sphinxupquote{\textless{}src\textgreater{}}} in the
+directory \sphinxcode{\sphinxupquote{\textless{}target\textgreater{}}}. \sphinxcode{\sphinxupquote{\textless{}src\textgreater{}}} has to be an existing directory and
+\sphinxcode{\sphinxupquote{\textless{}target\textgreater{}}} must not exist. Moreover, both directories have to be
within the same S3QL file system.
The replication will not take any additional space. Only if one of
directories is modified later on, the modified data will take
additional storage space.
-\sphinxcode{s3qlcp} can only be called by the user that mounted the file system
-and (if the file system was mounted with \sphinxcode{-{-}allow-other} or \sphinxcode{-{-}allow-root})
+\sphinxcode{\sphinxupquote{s3qlcp}} can only be called by the user that mounted the file system
+and (if the file system was mounted with \sphinxcode{\sphinxupquote{-{-}allow-other}} or \sphinxcode{\sphinxupquote{-{-}allow-root}})
the root user.
Note that:
\begin{itemize}
\item {}
After the replication, both source and target directory will still
-be completely ordinary directories. You can regard \sphinxcode{\textless{}src\textgreater{}} as a
-snapshot of \sphinxcode{\textless{}target\textgreater{}} or vice versa. However, the most common
-usage of \sphinxcode{s3qlcp} is to regularly duplicate the same source
-directory, say \sphinxcode{documents}, to different target directories. For a
+be completely ordinary directories. You can regard \sphinxcode{\sphinxupquote{\textless{}src\textgreater{}}} as a
+snapshot of \sphinxcode{\sphinxupquote{\textless{}target\textgreater{}}} or vice versa. However, the most common
+usage of \sphinxcode{\sphinxupquote{s3qlcp}} is to regularly duplicate the same source
+directory, say \sphinxcode{\sphinxupquote{documents}}, to different target directories. For a
e.g. monthly replication, the target directories would typically be
-named something like \sphinxcode{documents\_January} for the replication in
-January, \sphinxcode{documents\_February} for the replication in February etc.
+named something like \sphinxcode{\sphinxupquote{documents\_January}} for the replication in
+January, \sphinxcode{\sphinxupquote{documents\_February}} for the replication in February etc.
In this case it is clear that the target directories should be
regarded as snapshots of the source directory.
\item {}
Exactly the same effect could be achieved by an ordinary copy
-program like \sphinxcode{cp -a}. However, this procedure would be orders of
-magnitude slower, because \sphinxcode{cp} would have to read every file
+program like \sphinxcode{\sphinxupquote{cp -a}}. However, this procedure would be orders of
+magnitude slower, because \sphinxcode{\sphinxupquote{cp}} would have to read every file
completely (so that S3QL had to fetch all the data over the network
from the backend) before writing them into the destination folder.
@@ -1705,10 +1650,10 @@ from the backend) before writing them into the destination folder.
\subsection{Snapshotting vs Hardlinking}
-\label{special:snapshotting-vs-hardlinking}
+\label{\detokenize{special:snapshotting-vs-hardlinking}}
Snapshot support in S3QL is inspired by the hardlinking feature that
-is offered by programs like \href{http://www.samba.org/rsync}{rsync} or
-\href{http://savannah.nongnu.org/projects/storebackup}{storeBackup}.
+is offered by programs like \sphinxhref{http://www.samba.org/rsync}{rsync} or
+\sphinxhref{http://savannah.nongnu.org/projects/storebackup}{storeBackup}.
These programs can create a hardlink instead of copying a file if an
identical file already exists in the backup. However, using hardlinks
has two large disadvantages:
@@ -1731,17 +1676,19 @@ any backup program.
\section{Getting Statistics}
-\label{special:getting-statistics}\label{special:s3qlstat}
+\label{\detokenize{special:getting-statistics}}\label{\detokenize{special:s3qlstat}}
You can get more information about a mounted S3QL file system with the
-\sphinxcode{s3qlstat} command. It has the following syntax:
+\sphinxcode{\sphinxupquote{s3qlstat}} command. It has the following syntax:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qlstat }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mountpoint\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
This will print out something like this
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{Directory entries: 1488068}
\PYG{l}{Inodes: 1482991}
\PYG{l}{Data blocks: 87948}
@@ -1750,34 +1697,35 @@ This will print out something like this
\PYG{l}{After compression: 43 GiB (10.85\PYGZpc{} of total, 83.60\PYGZpc{} of de\PYGZhy{}duplicated)}
\PYG{l}{Database size: 172 MiB (uncompressed)}
\PYG{l}{(some values do not take into account not\PYGZhy{}yet\PYGZhy{}uploaded dirty blocks in cache)}
-\end{Verbatim}
+\end{sphinxVerbatim}
Probably the most interesting numbers are the total size of your data,
the total size after duplication, and the final size after
de-duplication and compression.
-\sphinxcode{s3qlstat} can only be called by the user that mounted the file system
-and (if the file system was mounted with \sphinxcode{-{-}allow-other} or \sphinxcode{-{-}allow-root})
+\sphinxcode{\sphinxupquote{s3qlstat}} can only be called by the user that mounted the file system
+and (if the file system was mounted with \sphinxcode{\sphinxupquote{-{-}allow-other}} or \sphinxcode{\sphinxupquote{-{-}allow-root}})
the root user.
-For a full list of available options, run \sphinxcode{s3qlstat -{-}help}.
+For a full list of available options, run \sphinxcode{\sphinxupquote{s3qlstat -{-}help}}.
\section{Immutable Trees}
-\label{special:s3qllock}\label{special:immutable-trees}
-The command \textbf{\texttt{s3qllock}} can be used to make a directory tree
+\label{\detokenize{special:immutable-trees}}\label{\detokenize{special:s3qllock}}
+The command \sphinxstyleliteralstrong{\sphinxupquote{s3qllock}} can be used to make a directory tree
immutable. Immutable trees can no longer be changed in any way
whatsoever. You can not add new files or directories and you can not
change or delete existing files and directories. The only way to get
-rid of an immutable tree is to use the \textbf{\texttt{s3qlrm}} command (see
+rid of an immutable tree is to use the \sphinxstyleliteralstrong{\sphinxupquote{s3qlrm}} command (see
below).
For example, to make the directory tree beneath the directory
-\sphinxcode{2010-04-21} immutable, execute
+\sphinxcode{\sphinxupquote{2010-04-21}} immutable, execute
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qllock 2010\PYGZhy{}04\PYGZhy{}21}
-\end{Verbatim}
+\end{sphinxVerbatim}
Immutability is a feature designed for backups. Traditionally, backups
have been made on external tape drives. Once a backup was made, the
@@ -1791,7 +1739,7 @@ all backups are available every time the file system is mounted.
Nothing prevents a file in an old backup from being changed again
later on. In the worst case, this may make your entire backup system
worthless. Imagine that your system gets infected by a nasty virus
-that simply deletes all files it can find -- if the virus is active
+that simply deletes all files it can find \textendash{} if the virus is active
while the backup file system is mounted, the virus will destroy all
your old backups as well!
@@ -1799,9 +1747,9 @@ Even if the possibility of a malicious virus or trojan horse is
excluded, being able to change a backup after it has been made is
generally not a good idea. A common S3QL use case is to keep the file
system mounted at all times and periodically create backups with
-\textbf{\texttt{rsync -a}}. This allows every user to recover her files from a
+\sphinxstyleliteralstrong{\sphinxupquote{rsync -a}}. This allows every user to recover her files from a
backup without having to call the system administrator. However, this
-also allows every user to accidentally change or delete files \emph{in} one
+also allows every user to accidentally change or delete files \sphinxstyleemphasis{in} one
of the old backups.
Making a backup immutable protects you against all these problems.
@@ -1811,32 +1759,34 @@ changed after they have been made immutable.
\section{Fast Recursive Removal}
-\label{special:fast-recursive-removal}\label{special:s3qlrm}
-The \sphinxcode{s3qlrm} command can be used to recursively delete files and
-directories on an S3QL file system. Although \sphinxcode{s3qlrm} is faster than
-using e.g. \sphinxcode{rm -r}, the main reason for its existence is that it
+\label{\detokenize{special:fast-recursive-removal}}\label{\detokenize{special:s3qlrm}}
+The \sphinxcode{\sphinxupquote{s3qlrm}} command can be used to recursively delete files and
+directories on an S3QL file system. Although \sphinxcode{\sphinxupquote{s3qlrm}} is faster than
+using e.g. \sphinxcode{\sphinxupquote{rm -r}}, the main reason for its existence is that it
allows you to delete immutable trees as well. The syntax is rather
simple:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qlrm }\PYG{n+nv}{\PYGZlt{}directory\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
Be warned that there is no additional confirmation. The directory will
be removed entirely and immediately.
\section{Runtime Configuration}
-\label{special:runtime-configuration}\label{special:s3qlctrl}
-The \sphinxcode{s3qlctrl} can be used to control a mounted S3QL file system. Its
+\label{\detokenize{special:runtime-configuration}}\label{\detokenize{special:s3qlctrl}}
+The \sphinxcode{\sphinxupquote{s3qlctrl}} can be used to control a mounted S3QL file system. Its
syntax is
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qlctrl }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}action\PYGZgt{}}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mountpoint\PYGZgt{}}\PYG{l}{ ...}
-\end{Verbatim}
+\end{sphinxVerbatim}
-\sphinxcode{\textless{}mountpoint\textgreater{}} must be the location of a mounted S3QL file system.
-For a list of valid options, run \sphinxcode{s3qlctrl -{-}help}. \sphinxcode{\textless{}action\textgreater{}}
+\sphinxcode{\sphinxupquote{\textless{}mountpoint\textgreater{}}} must be the location of a mounted S3QL file system.
+For a list of valid options, run \sphinxcode{\sphinxupquote{s3qlctrl -{-}help}}. \sphinxcode{\sphinxupquote{\textless{}action\textgreater{}}}
may be either of:
\begin{quote}
\begin{quote}\begin{description}
@@ -1862,36 +1812,37 @@ Trigger a metadata upload.
\chapter{Unmounting}
-\label{umount::doc}\label{umount:unmounting}
+\label{\detokenize{umount:unmounting}}\label{\detokenize{umount::doc}}
To unmount an S3QL file system, use the command:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{umount.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mountpoint\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
This will block until all data has been written to the backend.
-Only the user who mounted the file system with \textbf{\texttt{mount.s3ql}}
+Only the user who mounted the file system with \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}}
is able to unmount it again. If you are root and want to unmount an
S3QL file system mounted by an ordinary user, you have to use the
-\textbf{\texttt{fusermount -u}} or \textbf{\texttt{umount}} command instead. Note
+\sphinxstyleliteralstrong{\sphinxupquote{fusermount -u}} or \sphinxstyleliteralstrong{\sphinxupquote{umount}} command instead. Note
that these commands do not block until all data has been uploaded, so
-if you use them instead of \sphinxcode{umount.s3ql} then you should manually wait
-for the \sphinxcode{mount.s3ql} process to terminate before shutting down the
+if you use them instead of \sphinxcode{\sphinxupquote{umount.s3ql}} then you should manually wait
+for the \sphinxcode{\sphinxupquote{mount.s3ql}} process to terminate before shutting down the
system.
-The \textbf{\texttt{umount.s3ql}} command accepts the following options:
+The \sphinxstyleliteralstrong{\sphinxupquote{umount.s3ql}} command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
@@ -1904,69 +1855,70 @@ been closed.
\end{optionlist}
\end{quote}
-If, for some reason, the \sphinxcode{umount.sql} command does not work, the file
-system can also be unmounted with \sphinxcode{fusermount -u -z}. Note that this
+If, for some reason, the \sphinxcode{\sphinxupquote{umount.sql}} command does not work, the file
+system can also be unmounted with \sphinxcode{\sphinxupquote{fusermount -u -z}}. Note that this
command will return immediately and the file system may continue to
upload data in the background for a while longer.
\chapter{Checking for Errors}
-\label{fsck::doc}\label{fsck:checking-for-errors}
-It is recommended to periodically run the \textbf{\texttt{fsck.s3ql}} and
-\textbf{\texttt{s3ql\_verify}} commands (in this order) to ensure that the
+\label{\detokenize{fsck:checking-for-errors}}\label{\detokenize{fsck::doc}}
+It is recommended to periodically run the \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} and
+\sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} commands (in this order) to ensure that the
file system is consistent, and that there has been no data corruption
or data loss in the storage backend.
-\textbf{\texttt{fsck.s3ql}} is intended to detect and correct problems with
+\sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} is intended to detect and correct problems with
the internal file system structure, caused by e.g. a file system crash
or a bug in S3QL. It assumes that the storage backend can be fully
trusted, i.e. if the backend reports that a specific storage object
-exists, \textbf{\texttt{fsck.s3ql}} takes that as proof that the data is
+exists, \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} takes that as proof that the data is
present and intact.
-In contrast to that, the \textbf{\texttt{s3ql\_verify}} command is intended to
+In contrast to that, the \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} command is intended to
check the consistency of the storage backend. It assumes that the
internal file system data is correct, and verifies that all data can
-actually be retrieved from the backend. Running \textbf{\texttt{s3ql\_verify}}
-may therefore take much longer than running \textbf{\texttt{fsck.s3ql}}.
+actually be retrieved from the backend. Running \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}}
+may therefore take much longer than running \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}}.
\section{Checking and repairing internal file system errors}
-\label{fsck:checking-and-repairing-internal-file-system-errors}
-\textbf{\texttt{fsck.s3ql}} checks that the internal file system structure is
+\label{\detokenize{fsck:checking-and-repairing-internal-file-system-errors}}
+\sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} checks that the internal file system structure is
consistent and attempts to correct any problems it finds. If an S3QL
file system has not been unmounted correcly for any reason, you need
-to run \textbf{\texttt{fsck.s3ql}} before you can mount the file system
+to run \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} before you can mount the file system
again.
-The \textbf{\texttt{fsck.s3ql}} command has the following syntax:
+The \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} command has the following syntax:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{fsck.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
This command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}log \textless{}target\textgreater{}]
-Destination for log messages. Specify \sphinxcode{none} for
-standard output or \sphinxcode{syslog} for the system logging
+Destination for log messages. Specify \sphinxcode{\sphinxupquote{none}} for
+standard output or \sphinxcode{\sphinxupquote{syslog}} for the system logging
daemon. Anything else will be interpreted as a file
name. Log files will be rotated when they reach 1 MiB,
and at most 5 old log files will be kept. Default:
-\sphinxcode{\textasciitilde{}/.s3ql/fsck.log}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/fsck.log}}
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}backend-options \textless{}options\textgreater{}]
@@ -1976,7 +1928,7 @@ backend documentation for available options.
just print program version and exit
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-{-}keep-cache]
Do not purge locally cached files on exit.
\item [-{-}batch]
@@ -1991,41 +1943,42 @@ likely result in data loss.
\section{Detecting and handling backend data corruption}
-\label{fsck:detecting-and-handling-backend-data-corruption}\label{fsck:s3ql-verify}
-The \textbf{\texttt{s3ql\_verify}} command verifies all data in the file
-system. In contrast to \textbf{\texttt{fsck.s3ql}}, \textbf{\texttt{s3ql\_verify}}
+\label{\detokenize{fsck:detecting-and-handling-backend-data-corruption}}\label{\detokenize{fsck:s3ql-verify}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} command verifies all data in the file
+system. In contrast to \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}}, \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}}
does not trust the object listing returned by the backend, but
actually attempts to retrieve every object. By default,
-\textbf{\texttt{s3ql\_verify}} will attempt to retrieve just the metadata for
+\sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} will attempt to retrieve just the metadata for
every object (for e.g. the S3-compatible or Google Storage backends
-this corresponds to a \sphinxcode{HEAD} request for each object), which is
+this corresponds to a \sphinxcode{\sphinxupquote{HEAD}} request for each object), which is
generally sufficient to determine if the object still exists. When
-specifying the \sphinxcode{-{-}data} option, \textbf{\texttt{s3ql\_verify}} will
+specifying the \sphinxcode{\sphinxupquote{-{-}data}} option, \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} will
instead read every object entirely. To determine how much data will be
-transmitted in total when using \sphinxcode{-{-}data}, look at the \emph{After
-compression} row in the {\hyperref[special:s3qlstat]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlstat}}}} output.
+transmitted in total when using \sphinxcode{\sphinxupquote{-{-}data}}, look at the \sphinxstyleemphasis{After
+compression} row in the {\hyperref[\detokenize{special:s3qlstat}]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlstat}}}} output.
-\textbf{\texttt{s3ql\_verify}} is not able to correct any data corruption that
+\sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} is not able to correct any data corruption that
it finds. Instead, a list of the corrupted and/or missing objects is
written to a file and the decision about the proper course of action
is left to the user. If you have administrative access to the backend
server, you may want to investigate the cause of the corruption or
check if the missing/corrupted objects can be restored from
backups. If you believe that the missing/corrupted objects are indeed
-lost irrevocably, you can use the {\hyperref[contrib:remove\string-objects]{\sphinxcrossref{\DUrole{std,std-ref}{remove\_objects.py}}}} script (from
-the \sphinxcode{contrib} directory of the S3QL distribution) to explicitly
+lost irrevocably, you can use the {\hyperref[\detokenize{contrib:remove-objects}]{\sphinxcrossref{\DUrole{std,std-ref}{remove\_objects.py}}}} script (from
+the \sphinxcode{\sphinxupquote{contrib}} directory of the S3QL distribution) to explicitly
delete the objects from the storage backend. After that, you should
-run \textbf{\texttt{fsck.s3ql}}. Since the (now explicitly deleted) objects
+run \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}}. Since the (now explicitly deleted) objects
should now no longer be included in the object index reported by the
-backend, \textbf{\texttt{fsck.s3ql}} will identify the objects as missing,
+backend, \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} will identify the objects as missing,
update the internal file system structures accordingly, and move the
-affected files into the \sphinxcode{lost+found} directory.
+affected files into the \sphinxcode{\sphinxupquote{lost+found}} directory.
-The \textbf{\texttt{s3ql\_verify}} command has the following syntax:
+The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} command has the following syntax:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3ql\PYGZus{}verify }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
This command accepts the following options:
\begin{quote}
@@ -2034,24 +1987,24 @@ This command accepts the following options:
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
just print program version and exit
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}backend-options \textless{}options\textgreater{}]
Backend specific options (separate by commas). See
backend documentation for available options.
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-{-}missing-file \textless{}name\textgreater{}]
File to store keys of missing objects.
\item [-{-}corrupted-file \textless{}name\textgreater{}]
@@ -2069,15 +2022,15 @@ Skip over first \textless{}n\textgreater{} objects and with verifying object
\chapter{Storing Backend Information}
-\label{authinfo:authinfo}\label{authinfo::doc}\label{authinfo:storing-backend-information}
+\label{\detokenize{authinfo:storing-backend-information}}\label{\detokenize{authinfo:authinfo}}\label{\detokenize{authinfo::doc}}
Normally, S3QL reads username and password for the backend as well as
an encryption passphrase for the file system from the
terminal. Alternatively, these (and some other backend parameters) may
be specified in a configuration file specified by the
-\sphinxcode{-{-}authfile} parameter.
+\sphinxcode{\sphinxupquote{-{-}authfile}} parameter.
-The authinfo file consists of sections, led by a \sphinxcode{{[}section{]}}
-header and followed by \sphinxcode{name: value} entries. The section headers
+The authinfo file consists of sections, led by a \sphinxcode{\sphinxupquote{{[}section{]}}}
+header and followed by \sphinxcode{\sphinxupquote{name: value}} entries. The section headers
themselves are not used by S3QL but have to be unique within the file.
In each section, the following entries can be defined:
@@ -2101,15 +2054,16 @@ it is encrypted).
Furthermore, command line parameters that are shared between all S3QL
commands that work with storage URL may be specified in this file as
-well by omitting the leading dashes, e.g. the \sphinxcode{-{-}backend-options
-notls} parameter may be written into the authinfo file as
-\sphinxcode{backend-options: notls}.
+well by omitting the leading dashes, e.g. the \sphinxcode{\sphinxupquote{-{-}backend-options
+notls}} parameter may be written into the authinfo file as
+\sphinxcode{\sphinxupquote{backend-options: notls}}.
When reading the authinfo file, S3QL considers every applicable
section in order and uses the last value that it found for each entry.
For example, consider the following authentication file:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{g+ge}{[s3]}
\PYG{l}{storage\PYGZhy{}url: s3://}
\PYG{l}{backend\PYGZhy{}login: joe}
@@ -2128,31 +2082,31 @@ For example, consider the following authentication file:
\PYG{l}{backend\PYGZhy{}login: bill}
\PYG{l}{backend\PYGZhy{}password: bi23ll}
\PYG{l}{fs\PYGZhy{}passphrase: ll23bi}
-\end{Verbatim}
+\end{sphinxVerbatim}
-With this authentication file, S3QL would try to log in as ``joe''
+With this authentication file, S3QL would try to log in as “joe”
whenever the s3 backend is used, except when accessing a storage url
-that begins with ``s3://joes-second-bucket/with-prefix''. In that case,
-the last section becomes active and S3QL would use the ``bill''
+that begins with “s3://joes-second-bucket/with-prefix”. In that case,
+the last section becomes active and S3QL would use the “bill”
credentials. Furthermore, file system encryption passphrases will be used
-for storage urls that start with ``s3://joes-first-bucket'' or
-``s3://joes-second-bucket''.
+for storage urls that start with “s3://joes-first-bucket” or
+“s3://joes-second-bucket”.
-The authentication file is parsed by the \href{http://docs.python.org/library/configparser.html}{Python ConfigParser
+The authentication file is parsed by the \sphinxhref{http://docs.python.org/library/configparser.html}{Python ConfigParser
module}.
\chapter{Contributed Programs}
-\label{contrib::doc}\label{contrib:contributed-programs}
+\label{\detokenize{contrib:contributed-programs}}\label{\detokenize{contrib::doc}}
S3QL comes with a few contributed programs that are not part of the
core distribution (and are therefore not installed automatically by
default), but which may nevertheless be useful. These programs are in
-the \sphinxcode{contrib} directory of the source distribution or in
-\sphinxcode{/usr/share/doc/s3ql/contrib} if you installed S3QL from a package.
+the \sphinxcode{\sphinxupquote{contrib}} directory of the source distribution or in
+\sphinxcode{\sphinxupquote{/usr/share/doc/s3ql/contrib}} if you installed S3QL from a package.
\section{benchmark.py}
-\label{contrib:benchmark-py}
+\label{\detokenize{contrib:benchmark-py}}
This program measures S3QL write performance, uplink bandwidth and
compression speed to determine the limiting factor. It also gives
recommendation for compression algorithm and number of upload threads
@@ -2160,7 +2114,7 @@ to achieve maximum performance.
\section{clone\_fs.py}
-\label{contrib:clone-fs-py}
+\label{\detokenize{contrib:clone-fs-py}}
This program physically clones an S3QL file system from one backend
into another, without recompressing or reencrypting. It can be used to
migrate S3 buckets to a different storage region or storage class
@@ -2168,40 +2122,44 @@ migrate S3 buckets to a different storage region or storage class
\section{pcp.py}
-\label{contrib:pcp-py}\label{contrib:pcp}
-\sphinxcode{pcp.py} is a wrapper program that starts several rsync processes to
+\label{\detokenize{contrib:pcp-py}}\label{\detokenize{contrib:pcp}}
+\sphinxcode{\sphinxupquote{pcp.py}} is a wrapper program that starts several rsync processes to
copy directory trees in parallel. This is important because
transferring files in parallel significantly enhances performance when
-copying data from an S3QL file system (see {\hyperref[tips:copy\string-performance]{\sphinxcrossref{\DUrole{std,std-ref}{Improving copy performance}}}} for
+copying data from an S3QL file system (see {\hyperref[\detokenize{tips:copy-performance}]{\sphinxcrossref{\DUrole{std,std-ref}{Improving copy performance}}}} for
details).
-To recursively copy the directory \sphinxcode{/mnt/home-backup} into
-\sphinxcode{/home/joe} using 8 parallel processes and preserving permissions,
+To recursively copy the directory \sphinxcode{\sphinxupquote{/mnt/home-backup}} into
+\sphinxcode{\sphinxupquote{/home/joe}} using 8 parallel processes and preserving permissions,
you would execute
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{pcp.py \PYGZhy{}a \PYGZhy{}\PYGZhy{}processes=8 /mnt/home\PYGZhy{}backup/ /home/joe}
-\end{Verbatim}
+\end{sphinxVerbatim}
\section{s3ql\_backup.sh}
-\label{contrib:s3ql-backup-sh}
+\label{\detokenize{contrib:s3ql-backup-sh}}
This is an example script that demonstrates how to set up a simple but
-powerful backup solution using S3QL and \href{http://samba.org/rsync}{rsync}.
+powerful backup solution using S3QL and \sphinxhref{http://samba.org/rsync}{rsync}.
-The \sphinxcode{s3ql\_backup.sh} script automates the following steps:
+The \sphinxcode{\sphinxupquote{s3ql\_backup.sh}} script automates the following steps:
\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
\item {}
Mount the file system
\item {}
-Replicate the previous backup with {\hyperref[special:s3qlcp]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlcp}}}}
+Replicate the previous backup with {\hyperref[\detokenize{special:s3qlcp}]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlcp}}}}
\item {}
Update the new copy with the data from the backup source using rsync
\item {}
-Make the new backup immutable with {\hyperref[special:s3qllock]{\sphinxcrossref{\DUrole{std,std-ref}{s3qllock}}}}
+Make the new backup immutable with {\hyperref[\detokenize{special:s3qllock}]{\sphinxcrossref{\DUrole{std,std-ref}{s3qllock}}}}
\item {}
Delete old backups that are no longer needed
@@ -2212,17 +2170,17 @@ Unmount the file system
\end{enumerate}
The backups are stored in directories of the form
-\sphinxcode{YYYY-MM-DD\_HH:mm:SS} and the {\hyperref[contrib:expire\string-backups\string-py]{\sphinxcrossref{expire\_backups.py}}} command is used to
+\sphinxcode{\sphinxupquote{YYYY-MM-DD\_HH:mm:SS}} and the {\hyperref[\detokenize{contrib:expire-backups-py}]{\sphinxcrossref{expire\_backups.py}}} command is used to
delete old backups.
\section{expire\_backups.py}
-\label{contrib:expire-backups-py}
-\textbf{\texttt{expire\_backups.py}} is a program to intelligently remove old
+\label{\detokenize{contrib:expire-backups-py}}
+\sphinxstyleliteralstrong{\sphinxupquote{expire\_backups.py}} is a program to intelligently remove old
backups that are no longer needed.
To define what backups you want to keep for how long, you define a
-number of \emph{age ranges}. \textbf{\texttt{expire\_backups}} ensures that you
+number of \sphinxstyleemphasis{age ranges}. \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} ensures that you
will have at least one backup in each age range at all times. It will
keep exactly as many backups as are required for that and delete any
backups that become redundant.
@@ -2231,10 +2189,13 @@ Age ranges are specified by giving a list of range boundaries in terms
of backup cycles. Every time you create a new backup, the existing
backups age by one cycle.
-Example: when \textbf{\texttt{expire\_backups}} is called with the age range
-definition \sphinxcode{1 3 7 14 31}, it will guarantee that you always have the
+Example: when \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} is called with the age range
+definition \sphinxcode{\sphinxupquote{1 3 7 14 31}}, it will guarantee that you always have the
following backups available:
\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
\item {}
A backup that is 0 to 1 cycles old (i.e, the most recent backup)
@@ -2252,7 +2213,7 @@ A backup that is 14 to 31 cycles old
\end{enumerate}
-\begin{notice}{note}{Note:}
+\begin{sphinxadmonition}{note}{Note:}
If you do backups in fixed intervals, then one cycle will be
equivalent to the backup interval. The advantage of specifying the
age ranges in terms of backup cycles rather than days or weeks is
@@ -2262,69 +2223,72 @@ one month. Now all your backups are at least a month old, and if you
had specified the above backup strategy in terms of absolute ages,
they would all be deleted! Specifying age ranges in terms of backup
cycles avoids these sort of problems.
-\end{notice}
+\end{sphinxadmonition}
-\textbf{\texttt{expire\_backups}} usage is simple. It requires backups to be
-stored in directories of the form \sphinxcode{year-month-day\_hour:minute:seconds}
-(\sphinxcode{YYYY-MM-DD\_HH:mm:ss}) and works on all backups in the current
+\sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} usage is simple. It requires backups to be
+stored in directories of the form \sphinxcode{\sphinxupquote{year-month-day\_hour:minute:seconds}}
+(\sphinxcode{\sphinxupquote{YYYY-MM-DD\_HH:mm:ss}}) and works on all backups in the current
directory. So for the above backup strategy, the correct invocation
would be:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{expire\PYGZus{}backups.py 1 3 7 14 31}
-\end{Verbatim}
+\end{sphinxVerbatim}
When storing your backups on an S3QL file system, you probably want to
-specify the \sphinxcode{-{-}use-s3qlrm} option as well. This tells
-\textbf{\texttt{expire\_backups}} to use the {\hyperref[special:s3qlrm]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlrm}}}} command to
+specify the \sphinxcode{\sphinxupquote{-{-}use-s3qlrm}} option as well. This tells
+\sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} to use the {\hyperref[\detokenize{special:s3qlrm}]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlrm}}}} command to
delete directories.
-\textbf{\texttt{expire\_backups}} uses a ``state file'' to keep track which
+\sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} uses a “state file” to keep track which
backups are how many cycles old (since this cannot be inferred from
the dates contained in the directory names). The standard name for
-this state file is \sphinxcode{.expire\_backups.dat}. If this file gets
-damaged or deleted, \textbf{\texttt{expire\_backups}} no longer knows the ages
+this state file is \sphinxcode{\sphinxupquote{.expire\_backups.dat}}. If this file gets
+damaged or deleted, \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} no longer knows the ages
of the backups and refuses to work. In this case you can use the
-\sphinxcode{-{-}reconstruct-state} option to try to reconstruct the state
+\sphinxcode{\sphinxupquote{-{-}reconstruct-state}} option to try to reconstruct the state
from the backup dates. However, the accuracy of this reconstruction
depends strongly on how rigorous you have been with making backups (it
is only completely correct if the time between subsequent backups has
-always been exactly the same), so it's generally a good idea not to
+always been exactly the same), so it’s generally a good idea not to
tamper with the state file.
-For a full list of available options, run \textbf{\texttt{expire\_backups.py
+For a full list of available options, run \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups.py
-{-}help}}.
\section{remove\_objects.py}
-\label{contrib:remove-objects-py}\label{contrib:remove-objects}
-\textbf{\texttt{remove\_objects.py}} is a program to remove a list of objects
+\label{\detokenize{contrib:remove-objects-py}}\label{\detokenize{contrib:remove-objects}}
+\sphinxstyleliteralstrong{\sphinxupquote{remove\_objects.py}} is a program to remove a list of objects
from a storage backend. Since it acts on the backend-level, the
backend need not contain an S3QL file system.
\chapter{Tips \& Tricks}
-\label{tips::doc}\label{tips:tips-tricks}
+\label{\detokenize{tips:tips-tricks}}\label{\detokenize{tips::doc}}
\section{SSH Backend}
-\label{tips:ssh-backend}\label{tips:ssh-tipp}
-By combining S3QL's local backend with \href{http://fuse.sourceforge.net/sshfs.html}{sshfs}, it is possible to store an
+\label{\detokenize{tips:ssh-backend}}\label{\detokenize{tips:ssh-tipp}}
+By combining S3QL’s local backend with \sphinxhref{http://fuse.sourceforge.net/sshfs.html}{sshfs}, it is possible to store an
S3QL file system on arbitrary SSH servers: first mount the remote
target directory into the local filesystem,
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{sshfs user@my.server.com:/mnt/s3ql /mnt/sshfs}
-\end{Verbatim}
+\end{sphinxVerbatim}
and then give the mountpoint to S3QL as a local destination:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{mount.s3ql local:///mnt/sshfs/myfsdata /mnt/s3ql}
-\end{Verbatim}
+\end{sphinxVerbatim}
\section{Permanently mounted backup file system}
-\label{tips:permanently-mounted-backup-file-system}
+\label{\detokenize{tips:permanently-mounted-backup-file-system}}
If you use S3QL as a backup file system, it can be useful to mount the
file system permanently (rather than just mounting it for a backup and
unmounting it afterwards). Especially if your file system becomes
@@ -2334,27 +2298,27 @@ to restore a single file.
If you decide to do so, you should make sure to
\begin{itemize}
\item {}
-Use {\hyperref[special:s3qllock]{\sphinxcrossref{\DUrole{std,std-ref}{s3qllock}}}} to ensure that backups are immutable
+Use {\hyperref[\detokenize{special:s3qllock}]{\sphinxcrossref{\DUrole{std,std-ref}{s3qllock}}}} to ensure that backups are immutable
after they have been made.
\item {}
-Call {\hyperref[special:s3qlctrl]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlctrl upload-meta}}}} right after a every
+Call {\hyperref[\detokenize{special:s3qlctrl}]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlctrl upload-meta}}}} right after a every
backup to make sure that the newest metadata is stored safely (if
you do backups often enough, this may also allow you to set the
-\sphinxcode{-{-}metadata-upload-interval} option of \textbf{\texttt{mount.s3ql}}
+\sphinxcode{\sphinxupquote{-{-}metadata-upload-interval}} option of \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}}
to zero).
\end{itemize}
\section{Improving copy performance}
-\label{tips:copy-performance}\label{tips:improving-copy-performance}
-\begin{notice}{note}{Note:}
-The following applies only when copying data \textbf{from} an S3QL file
-system, \textbf{not} when copying data \textbf{to} an S3QL file system.
-\end{notice}
+\label{\detokenize{tips:improving-copy-performance}}\label{\detokenize{tips:copy-performance}}
+\begin{sphinxadmonition}{note}{Note:}
+The following applies only when copying data \sphinxstylestrong{from} an S3QL file
+system, \sphinxstylestrong{not} when copying data \sphinxstylestrong{to} an S3QL file system.
+\end{sphinxadmonition}
-If you want to copy a lot of smaller files \emph{from} an S3QL file system
+If you want to copy a lot of smaller files \sphinxstyleemphasis{from} an S3QL file system
(e.g. for a system restore) you will probably notice that the
performance is rather bad.
@@ -2367,7 +2331,7 @@ network data.
Theoretically, this problem is easy to solve: you just have to copy
several files at the same time. In practice, however, almost all unix
-utilities (\sphinxcode{cp}, \sphinxcode{rsync}, \sphinxcode{tar} and friends) insist on copying
+utilities (\sphinxcode{\sphinxupquote{cp}}, \sphinxcode{\sphinxupquote{rsync}}, \sphinxcode{\sphinxupquote{tar}} and friends) insist on copying
data one file at a time. This makes a lot of sense when copying data
on the local hard disk, but in case of S3QL this is really
unfortunate.
@@ -2378,10 +2342,11 @@ make sure that they work on different sets of files.
For example, the following script will start 3 rsync instances. The
first instance handles all filenames starting with a-f, the second the
-filenames from g-l and the third covers the rest. The \sphinxcode{+ */} rule
+filenames from g-l and the third covers the rest. The \sphinxcode{\sphinxupquote{+ */}} rule
ensures that every instance looks into all directories.
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{c}{\PYGZsh{}!/bin/bash}
\PYG{l}{RSYNC\PYGZus{}ARGS=\PYGZdq{}\PYGZhy{}aHv /mnt/s3ql/ /home/restore/\PYGZdq{}}
@@ -2391,21 +2356,321 @@ ensures that every instance looks into all directories.
\PYG{l}{rsync \PYGZhy{}f \PYGZdq{}+ */\PYGZdq{} \PYGZhy{}f \PYGZdq{}\PYGZhy{} }\PYG{g+ge}{[a\PYGZhy{}l]}\PYG{l}{*\PYGZdq{} \PYGZdl{}RSYNC\PYGZus{}ARGS \PYGZam{}}
\PYG{l}{wait}
-\end{Verbatim}
+\end{sphinxVerbatim}
The optimum number of parallel processes depends on your network
connection and the size of the files that you want to transfer.
However, starting about 10 processes seems to be a good compromise
that increases performance dramatically in almost all situations.
-S3QL comes with a script named \sphinxcode{pcp.py} in the \sphinxcode{contrib} directory
+S3QL comes with a script named \sphinxcode{\sphinxupquote{pcp.py}} in the \sphinxcode{\sphinxupquote{contrib}} directory
that can be used to transfer files in parallel without having to write
-an explicit script first. See the description of {\hyperref[contrib:pcp]{\sphinxcrossref{\DUrole{std,std-ref}{pcp.py}}}} for
+an explicit script first. See the description of {\hyperref[\detokenize{contrib:pcp}]{\sphinxcrossref{\DUrole{std,std-ref}{pcp.py}}}} for
details.
+\chapter{Frequently Asked Questions}
+\label{\detokenize{faq:frequently-asked-questions}}\label{\detokenize{faq::doc}}
+
+\section{What does “python-apsw must be linked dynamically to sqlite3” mean?}
+\label{\detokenize{faq:what-does-python-apsw-must-be-linked-dynamically-to-sqlite3-mean}}
+This error occurs if your python-apsw module is statically linked
+against SQLite. You need to recompile and install the module with the
+proper settings for dynamic linking.
+
+If you are using Ubuntu or Debian, make sure that you are \sphinxstylestrong{not}
+using the apsw PPA at
+\sphinxurl{https://launchpad.net/~ubuntu-rogerbinns/+archive/apsw}, since this PPA
+provides statically linked packages. Instead, use the \sphinxstyleemphasis{python-apsw}
+packages shipped with Debian/Ubuntu. You can reinstall the package
+(after removing the apsw PPA from \sphinxcode{\sphinxupquote{/etc/apt/sources.list}} and
+\sphinxcode{\sphinxupquote{/etc/apt/sources.list.d/*}} with:
+
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\PYG{c}{\PYGZsh{} dpkg \PYGZhy{}\PYGZhy{}purge \PYGZhy{}\PYGZhy{}force\PYGZhy{}depends python\PYGZhy{}apsw}
+\PYG{c}{\PYGZsh{} apt\PYGZhy{}get install python\PYGZhy{}apsw}
+\end{sphinxVerbatim}
+
+
+\section{How can I improve the file system throughput?}
+\label{\detokenize{faq:how-can-i-improve-the-file-system-throughput}}
+There are three possible limiting factors for file system throughput:
+\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
+\item {}
+Throughput from process through kernel to S3QL
+
+\item {}
+Compression speed
+
+\item {}
+Upload speed
+
+\end{enumerate}
+
+To figure out what’s the limiting factor in your case, you can use the
+script \sphinxcode{\sphinxupquote{contrib/benchmark.py}} in the S3QL tarball. It will
+determine the individual throughputs, and also give a recommendation
+for compression algorithm and number of upload threads.
+
+
+\section{Why does \sphinxstyleliteralintitle{\sphinxupquote{df}} show 1 TB of free space?}
+\label{\detokenize{faq:why-does-df-show-1-tb-of-free-space}}
+The file system size of S3QL is unlimited. However, most Unix
+utilities (including \sphinxcode{\sphinxupquote{df}}) have no concept of an infinite size, so
+S3QL has to provide some numerical value. Therefore, S3QL always
+reports that the file system is 50\% free, but it also reports at least
+1 TB. This means that if you store 1.5 TB you will have another 1.5 TB
+free, but if you store just 2 MB, you will still have TB free rather
+than just another 2 MB.
+
+
+\section{Which operating systems are supported?}
+\label{\detokenize{faq:which-operating-systems-are-supported}}
+S3QL is developed on Linux, but should in principle work on all FUSE
+supported operating systems that have the required Python modules. The
+\sphinxstyleliteralstrong{\sphinxupquote{\{umount.s3ql}} program does some tricks which may not work on
+non-Linux systems, but you can always umount with the \sphinxcode{\sphinxupquote{fusermount
+-u}} command provided by FUSE itself (the only difference is that it
+will not block until all data has been uploaded to S3 but return
+immediately). Please report your success (or failure) with other
+operating systems on the mailing list, so that this information can be
+extended.
+
+
+\section{Is there a file size limit?}
+\label{\detokenize{faq:is-there-a-file-size-limit}}
+No, S3QL puts no limits on the size of your files. Any limits on
+maximum object size imposed by the storage service do not matter for
+S3QL, since files are automatically and transparently split into
+smaller blocks.
+
+
+\section{Suppose I want to make a small change in a very large file. Will S3QL download and re-upload the entire file?}
+\label{\detokenize{faq:suppose-i-want-to-make-a-small-change-in-a-very-large-file-will-s3ql-download-and-re-upload-the-entire-file}}
+No, S3QL splits files in blocks of a configurable size (default: 10 MB). So to make a small change in a big file, only one block needs to be transferred and not the entire file.
+
+
+\section{I don’t quite understand this de-duplication feature…}
+\label{\detokenize{faq:i-don-t-quite-understand-this-de-duplication-feature}}
+The great thing about data de-duplication is that you don’t need to know anything about it and will still get all the benefits. Towards you, S3QL will behave and look exactly like a file system without data duplication. When talking to the storage backend, however, the S3QL will try to store identical data only once and thus occupy less space than an ordinary file system would.
+
+
+\section{What does the “Transport endpoint not connected” error mean?}
+\label{\detokenize{faq:what-does-the-transport-endpoint-not-connected-error-mean}}
+It means that the file system has crashed. Please check
+\sphinxcode{\sphinxupquote{mount.log}} for a more useful error message and report a bug if
+appropriate. If you can’t find any errors in \sphinxcode{\sphinxupquote{mount.log}}, the
+mount process may have “segfaulted”. To confirm this, look for a
+corresponding message in the \sphinxstyleliteralstrong{\sphinxupquote{dmesg}} output. If the mount process
+segfaulted, please try to obtain a C backtrace (see {[}{[}Providing
+Debugging Info{]}{]}) of the crash and file a bug report.
+
+To make the mountpoint available again (i.e., unmount the crashed file
+system), use the \sphinxcode{\sphinxupquote{fusermount -u}} command.
+
+Before reporting a bug, please make sure that you’re not just using
+the most recent S3QL version, but also the most-recent version of the
+most important dependencies (python-llfuse, python-apsw, python-lzma).
+
+
+\section{What does “Backend reports that fs is still mounted elsewhere, aborting” mean?}
+\label{\detokenize{faq:what-does-backend-reports-that-fs-is-still-mounted-elsewhere-aborting-mean}}
+It means that either the file systems has not been unmounted cleanly,
+or the data from the most-recent mount is not yet available from the
+backend. In the former case you should try to run fsck on the computer
+where the file system has been mounted most recently. In the later
+case, waiting may fix the problem: many storage providers have a
+so-called “consistency window” for which recently uploaded data may
+not yet be available for download. If you know that your backend is
+fully consistent, or the consistency window has passed, you can also
+run fsck in this situation. S3QL will then assume that whatever data
+is missing at this point is not going to show up again in the
+future. Affected files will be moved to /lost+found.
+
+
+\section{Can I access an S3QL file system on multiple computers simultaneously?}
+\label{\detokenize{faq:can-i-access-an-s3ql-file-system-on-multiple-computers-simultaneously}}
+To share a file system between several computers, you need to have a
+method for these computers to communicate, so that they can tell each
+other when they are changing data. However, S3QL is designed to store
+data in cloud storage services which can not be used for this kind of
+communication, because different computers may end up talking to
+different servers in the cloud (and there is no way for S3QL to force
+the cloud servers to synchronize quickly and often enough).
+
+Therefore, the only way to share an S3QL file system among different
+computers is to have one “master” computer that runs \sphinxstyleemphasis{mount.s3ql},
+and then shares the mountpoint over a network file system like NFS,
+CIFS or sshfs. If the participating computers are connected over an
+insecure network, NFS and CIFS should be combined with VPN software
+like \sphinxhref{http://www.tinc-vpn.org/}{Tinc} (which is very easy to set up
+for a few computers) or OpenVPN (which is a lot more complicated).
+
+In principle, both VPN and NFS/CIFS-alike functionality could be
+integrated into S3QL to allow simultaneous mounting using
+\sphinxstyleemphasis{mount.s3ql} directly. However, consensus among the S3QL developers
+is that this is not worth the increased complexity.
+
+
+\section{What maximum object size should I use?}
+\label{\detokenize{faq:what-maximum-object-size-should-i-use}}
+The \sphinxcode{\sphinxupquote{-{-}max-obj-size}} option of the \sphinxstyleliteralstrong{\sphinxupquote{mkfs.s3ql}}
+command determines the maximum size of the data chunks that S3QL
+exchanges with the backend server.
+
+For files smaller than the maximum object size, this option has no
+effect. Files larger than the maximum object size are split into
+multiple chunks. Whenever you upload or download data from the
+backend, this is done in complete chunks. So if you have configured a
+maximum object size of 10 MB, and want to read (or write) 5 bytes in a
+100 MB file, you will still download (or upload) 10 MB of data. If you
+decreased the maximum object size to 5 MB, you’d download/upload 5 MB.
+
+On the other hand, if you want to read the whole 100 MB, and have
+configured an object size of 10 MB, S3QL will have to send 10 separate
+requests to the backend. With a maximum object size of 1 MB, there’d
+be 100 separate requests. The larger the number of requests, the more
+inefficient this becomes, because there is a fixed time associated
+with the processing of each request. Also, many storage providers
+charge a fixed amount for each request, so downloading 100 MB in one
+request of 100 MB is cheaper than downloading it with 100 requests of
+1 MB.
+
+When choosing a maximum object size, you have to find a balance
+between these two effects. The bigger the size, the less requests will
+be used, but the more data is transfered uselessly. The smaller the
+size, the more requests will be used, but less traffic will be wasted.
+
+Generally you should go with the default unless you have a good reason
+to change it. When adjusting the value, keep in mind that it only
+affects files larger than the maximum object size. So if most of your
+files are less than 1 MB, decreasing the maximum object size from the
+default 10 MB to 1 MB will have almost no effect.
+
+
+\section{Is there a way to make the cache persistent / access the file system offline?}
+\label{\detokenize{faq:is-there-a-way-to-make-the-cache-persistent-access-the-file-system-offline}}
+No, there is no way to do this. However, for most use-cases this
+feature is actually not required. If you want to ensure that all data
+in a directory is stored in the cloud \sphinxstyleemphasis{and} available offline, all you
+need to do is store your data in a local directory that you
+periodically synchronize to an S3QL mountpoint. For example, if you
+would like to have an S3QL mountpoint with persistent cache at
+\sphinxcode{\sphinxupquote{/mnt/data}}, you get can this as follows:
+\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
+\item {}
+Mount a local block device at \sphinxcode{\sphinxupquote{/mnt/data}}, e.g. using ext4 or btrfs
+
+\item {}
+Mount an S3QL file system at \sphinxcode{\sphinxupquote{/mnt/data\_online}} using a small
+cache size and number of threads (eg. \sphinxcode{\sphinxupquote{-{-}threads
+2 -{-}max-cache-entries 10}}).
+
+\item {}
+Keep \sphinxcode{\sphinxupquote{/mnt/data\_online}} synchronized with \sphinxcode{\sphinxupquote{/mnt/data}}
+by either
+\begin{itemize}
+\item {}
+Periodically running rsync, e.g. by calling
+\sphinxcode{\sphinxupquote{rsync -aHA -{-}delete-during -{-}partial}} from cron, or
+
+\item {}
+Continously synchronizing using e.g. \sphinxhref{https://github.com/drunomics/syncd/blob/master/watch.sh}{watch.sh} or
+\sphinxhref{https://code.google.com/p/lsyncd/}{lsyncd} (these programs use
+\sphinxstyleemphasis{inotify} to constantly monitor the source directory and
+immediately copy over any changes)
+
+\end{itemize}
+
+\item {}
+Now use \sphinxcode{\sphinxupquote{/mnt/data}} in the same way as you would use an S3QL
+file system with a persistent cache.
+
+\end{enumerate}
+
+
+\section{I would like to use S3QL with Hubic, but…}
+\label{\detokenize{faq:i-would-like-to-use-s3ql-with-hubic-but}}
+\sphinxhref{http://www.hubic.com/}{HubiC} has a terribly designed API,
+effectively no customer service, and the servers are unreliable and
+produce sporadic weird errors. Don’t expect any help if you encounter
+problems with S3QL and hubiC.
+
+
+\section{What’s a reasonable metadata upload interval?}
+\label{\detokenize{faq:what-s-a-reasonable-metadata-upload-interval}}
+The metadata upload interval can be specified using the
+\sphinxcode{\sphinxupquote{-{-}metadata-upload-interval}} option of \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}}
+and a reasonable value to use is (surprise!) the default of 24 hours.
+
+To understand why intervals smaller than a few hours do not make
+sense, consider what happens during a metadata upload:
+\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
+\item {}
+The file system is frozen (all requests will block)
+
+\item {}
+The entire SQLite database holding the metadata is dumped into a
+more space efficient format.
+
+\item {}
+The file system is unfrozen
+
+\item {}
+The dumped database is uploaded
+
+\item {}
+The previous metadata is backed up, and backups are rotated
+
+\end{enumerate}
+
+In other words, uploading metadata is a very expensive operation that
+typically takes several seconds to several minutes.
+
+On the other hand, consider the situation that the periodic upload is
+intended to prevent:
+\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
+\item {}
+Your computer crashes, and the SQLite database in your S3QL cache
+directory is \sphinxstylestrong{irreparably} corrupted or lost.
+
+\end{enumerate}
+
+This is a \sphinxstyleemphasis{very} unlikely situation. When \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} crashes
+(but your computer keeps running), the local metadata will not get
+corrupted. If your entire computer crashes (e.g. because of a power
+outage), \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} is almost always still able to recover the
+local metadata. You have to be exceedingly unlucky to depend on the
+periodically uploaded metadata.
+
+In other words, if you set the metadata upload interval to \sphinxstyleemphasis{x}
+hours, what you are saying is that you consider your system so
+unstable that there is a good chance that your local hard disk will be
+irreparably corrupted sometime in the next \sphinxstyleemphasis{x} hours. In such a
+situation, you should thus be \sphinxstylestrong{backing up your entire system every
+*x* hours} (not just the S3QL metadata). If the metadata upload
+interval coincides with the interval at which you’re doing full system
+backups (not necessarily using S3QL), you are using the right
+value. If the metadata upload interval is smaller (or if you’re not
+doing full system backups at all), you are probably uploading metadata
+too often.
+
+
\chapter{Known Issues}
-\label{issues:known-issues}\label{issues::doc}\begin{itemize}
+\label{\detokenize{issues:known-issues}}\label{\detokenize{issues::doc}}\begin{itemize}
\item {}
S3QL de-duplicates data blocks based solely only on SHA256
checksums, without doing a byte-by-byte comparison of the blocks.
@@ -2421,69 +2686,68 @@ size of 4 kB) is therefore not recommended. Being exceptionally
unlucky may also be a disadvantage.
\item {}
-S3QL does not support Access Control Lists (ACLs). This is due to a
-bug in the FUSE library and will therefore hopefully be fixed at
-some point. See \href{https://bitbucket.org/nikratio/s3ql/issue/16/support-access-control-lists-acls}{issue \#16}
-for more details.
+S3QL does not support Access Control Lists (ACLs). There is nothing
+fundamentally that prevents this, someone just has to write the
+necessary code.
\item {}
-As of Linux kernel 3.5 S3QL file systems do not implement the ``write
-protect'' bit on directories. In other words, even if a directory has
+As of Linux kernel 3.5 S3QL file systems do not implement the “write
+protect” bit on directories. In other words, even if a directory has
the write protect bit set, the owner of the directory can delete any
files and (empty) subdirectories inside it. This is a bug in the
FUSE kernel module
-(cf. \url{https://github.com/libfuse/libfuse/issues/23}) and needs to be
+(cf. \sphinxurl{https://github.com/libfuse/libfuse/issues/23}) and needs to be
fixed in the kernel. Unfortunately it does not look as if this is
going to be fixed anytime soon (as of 2016/2/28).
\item {}
S3QL is rather slow when an application tries to write data in
unreasonably small chunks. If a 1 MiB file is copied in chunks of 1
-KB, this will take more than 10 times as long as when it's copied
+KB, this will take more than 10 times as long as when it’s copied
with the (recommended) chunk size of 128 KiB.
This is a limitation of the FUSE library (which does not yet support
write caching) which will hopefully be addressed in some future FUSE
version.
-Most applications, including e.g. GNU \sphinxcode{cp} and \sphinxcode{rsync}, use
+Most applications, including e.g. GNU \sphinxcode{\sphinxupquote{cp}} and \sphinxcode{\sphinxupquote{rsync}}, use
reasonably large buffers and are therefore not affected by this
problem and perform very efficient on S3QL file systems.
However, if you encounter unexpectedly slow performance with a
specific program, this might be due to the program using very small
write buffers. Although this is not really a bug in the program,
-it might be worth to ask the program's authors for help.
+it might be worth to ask the program’s authors for help.
\item {}
-S3QL always updates file and directory access times as if the \sphinxcode{relatime}
-mount option has been specified: the access time (``atime'') is only updated
+S3QL always updates file and directory access times as if the \sphinxcode{\sphinxupquote{relatime}}
+mount option has been specified: the access time (“atime”) is only updated
if it is currently earlier than either the status change time
-(``ctime'') or modification time (``mtime'').
+(“ctime”) or modification time (“mtime”).
\item {}
-S3QL directories always have an \sphinxcode{st\_nlink} value of 1. This may confuse
-programs that rely on directories having \sphinxcode{st\_nlink} values of \emph{(2 +
+S3QL directories always have an \sphinxcode{\sphinxupquote{st\_nlink}} value of 1. This may confuse
+programs that rely on directories having \sphinxcode{\sphinxupquote{st\_nlink}} values of \sphinxstyleemphasis{(2 +
number of sub directories)}.
Note that this is not a bug in S3QL. Including sub directories in
-the \sphinxcode{st\_nlink} value is a Unix convention, but by no means a
+the \sphinxcode{\sphinxupquote{st\_nlink}} value is a Unix convention, but by no means a
requirement. If an application blindly relies on this convention
being followed, then this is a bug in the application.
A prominent example are early versions of GNU find, which required
-the \sphinxcode{-{-}noleaf} option to work correctly on S3QL file systems. This
+the \sphinxcode{\sphinxupquote{-{-}noleaf}} option to work correctly on S3QL file systems. This
bug has already been fixed in recent find versions.
\item {}
-The \sphinxcode{umount} and \sphinxcode{fusermount -u} commands will \emph{not} block until all
-data has been uploaded to the backend. (this is a FUSE limitation
-that will hopefully be removed in the future, see \href{https://bitbucket.org/nikratio/s3ql/issue/1/blocking-fusermount-and-umount}{issue \#1}). If
-you use either command to unmount an S3QL file system, you have to
-take care to explicitly wait for the \sphinxcode{mount.s3ql} process to
-terminate before you shut down or restart the system. Therefore it
-is generally not a good idea to mount an S3QL file system in
-\sphinxcode{/etc/fstab} (you should use a dedicated init script instead).
+The \sphinxcode{\sphinxupquote{umount}} and \sphinxcode{\sphinxupquote{fusermount -u}} commands will \sphinxstyleemphasis{not} block until all
+data has been uploaded to the backend. (this is a FUSE limitation,
+cf. \sphinxurl{https://github.com/libfuse/libfuse/issues/1}). If you use either
+command to unmount an S3QL file system, you have to take care to
+explicitly wait for the \sphinxcode{\sphinxupquote{mount.s3ql}} process to terminate before you
+shut down or restart the system. Therefore it is generally not a
+good idea to mount an S3QL file system in \sphinxcode{\sphinxupquote{/etc/fstab}} (you should
+use a dedicated init script instead).
\item {}
S3QL relies on the backends not to run out of space. This is a given
@@ -2512,52 +2776,53 @@ newer removes this limitation.
\chapter{Manpages}
-\label{man/index::doc}\label{man/index:manpages}
+\label{\detokenize{man/index:manpages}}\label{\detokenize{man/index::doc}}
The man pages are installed with S3QL on your system and can be viewed
-with the \textbf{\texttt{man}} command. For reference, they are also included
-here in the User's Guide.
+with the \sphinxstyleliteralstrong{\sphinxupquote{man}} command. For reference, they are also included
+here in the User’s Guide.
-\section{The \textbf{\texttt{mkfs.s3ql}} command}
-\label{man/mkfs::doc}\label{man/mkfs:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{mkfs.s3ql}} command}
+\label{\detokenize{man/mkfs:the-command-command}}\label{\detokenize{man/mkfs::doc}}
\subsection{Synopsis}
-\label{man/mkfs:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/mkfs:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{mkfs.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/mkfs:description}
-The \textbf{\texttt{mkfs.s3ql}} command creates a new file system in the location
-specified by \emph{storage url}. The storage url depends on the backend
-that is used. The S3QL User's Guide should be consulted for a
+\label{\detokenize{man/mkfs:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{mkfs.s3ql}} command creates a new file system in the location
+specified by \sphinxstyleemphasis{storage url}. The storage url depends on the backend
+that is used. The S3QL User’s Guide should be consulted for a
description of the available backends.
-Unless you have specified the \sphinxcode{-{-}plain} option, \sphinxcode{mkfs.s3ql} will ask
-you to enter an encryption password. This password will \emph{not} be read
-from an authentication file specified with the \sphinxcode{-{-}authfile}
+Unless you have specified the \sphinxcode{\sphinxupquote{-{-}plain}} option, \sphinxcode{\sphinxupquote{mkfs.s3ql}} will ask
+you to enter an encryption password. This password will \sphinxstyleemphasis{not} be read
+from an authentication file specified with the \sphinxcode{\sphinxupquote{-{-}authfile}}
option to prevent accidental creation of an encrypted file system.
\subsection{Options}
-\label{man/mkfs:options}
-The \textbf{\texttt{mkfs.s3ql}} command accepts the following options.
+\label{\detokenize{man/mkfs:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{mkfs.s3ql}} command accepts the following options.
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}backend-options \textless{}options\textgreater{}]
@@ -2567,7 +2832,7 @@ backend documentation for available options.
just print program version and exit
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-L \textless{}name\textgreater{}]
Filesystem label
\item [-{-}max-obj-size \textless{}size\textgreater{}]
@@ -2583,8 +2848,8 @@ Overwrite any existing data.
\subsection{Exit Codes}
-\label{man/mkfs:exit-codes}
-\textbf{\texttt{mkfs.s3ql}} may terminate with the following exit codes:
+\label{\detokenize{man/mkfs:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{mkfs.s3ql}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -2618,7 +2883,7 @@ No permission to access backend (Authorization denied).
Invalid storage URL, specified location does not exist in backend.
\item[{19}] \leavevmode
-Unable to connect to backend, can't resolve hostname.
+Unable to connect to backend, can’t resolve hostname.
\item[{45}] \leavevmode
Unable to access cache directory.
@@ -2627,80 +2892,81 @@ Unable to access cache directory.
\subsection{See Also}
-\label{man/mkfs:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/mkfs:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{s3qladm}} command}
-\label{man/adm::doc}\label{man/adm:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{s3qladm}} command}
+\label{\detokenize{man/adm:the-command-command}}\label{\detokenize{man/adm::doc}}
\subsection{Synopsis}
-\label{man/adm:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/adm:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qladm }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}action\PYGZgt{}}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
-where \sphinxcode{action} may be either of \textbf{\texttt{passphrase}},
-\textbf{\texttt{upgrade}}, \textbf{\texttt{delete}} or \textbf{\texttt{download-metadata}}.
+where \sphinxcode{\sphinxupquote{action}} may be either of \sphinxstyleliteralstrong{\sphinxupquote{passphrase}},
+\sphinxstyleliteralstrong{\sphinxupquote{upgrade}}, \sphinxstyleliteralstrong{\sphinxupquote{delete}} or \sphinxstyleliteralstrong{\sphinxupquote{download-metadata}}.
\subsection{Description}
-\label{man/adm:description}
-The \textbf{\texttt{s3qladm}} command performs various operations on \emph{unmounted} S3QL
-file systems. The file system \emph{must not be mounted} when using
-\textbf{\texttt{s3qladm}} or things will go wrong badly.
+\label{\detokenize{man/adm:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qladm}} command performs various operations on \sphinxstyleemphasis{unmounted} S3QL
+file systems. The file system \sphinxstyleemphasis{must not be mounted} when using
+\sphinxstyleliteralstrong{\sphinxupquote{s3qladm}} or things will go wrong badly.
-The storage url depends on the backend that is used. The S3QL User's
+The storage url depends on the backend that is used. The S3QL User’s
Guide should be consulted for a description of the available backends.
\subsection{Options}
-\label{man/adm:options}
-The \textbf{\texttt{s3qladm}} command accepts the following options.
+\label{\detokenize{man/adm:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qladm}} command accepts the following options.
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}log \textless{}target\textgreater{}]
-Destination for log messages. Specify \sphinxcode{none} for
-standard output or \sphinxcode{syslog} for the system logging
+Destination for log messages. Specify \sphinxcode{\sphinxupquote{none}} for
+standard output or \sphinxcode{\sphinxupquote{syslog}} for the system logging
daemon. Anything else will be interpreted as a file
name. Log files will be rotated when they reach 1 MiB,
and at most 5 old log files will be kept. Default:
-\sphinxcode{None}
+\sphinxcode{\sphinxupquote{None}}
\item [-{-}backend-options \textless{}options\textgreater{}]
Backend specific options (separate by commas). See
backend documentation for available options.
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}version]
just print program version and exit
\end{optionlist}
\end{quote}
-Hint: run \sphinxcode{s3qladm \textless{}action\textgreater{} -{-}help} to get help on the additional arguments
+Hint: run \sphinxcode{\sphinxupquote{s3qladm \textless{}action\textgreater{} -{-}help}} to get help on the additional arguments
that the different actions take.
\subsection{Actions}
-\label{man/adm:actions}
+\label{\detokenize{man/adm:actions}}
The following actions may be specified:
\begin{description}
\item[{passphrase}] \leavevmode
@@ -2719,8 +2985,8 @@ Interactively download backups of the file system metadata.
\subsection{Exit Codes}
-\label{man/adm:exit-codes}
-\textbf{\texttt{s3qladm}} may terminate with the following exit codes:
+\label{\detokenize{man/adm:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{s3qladm}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -2763,7 +3029,7 @@ Wrong file system passphrase.
No S3QL file system found at given storage URL.
\item[{19}] \leavevmode
-Unable to connect to backend, can't resolve hostname.
+Unable to connect to backend, can’t resolve hostname.
\item[{45}] \leavevmode
Unable to access cache directory.
@@ -2772,56 +3038,57 @@ Unable to access cache directory.
\subsection{See Also}
-\label{man/adm:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/adm:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{mount.s3ql}} command}
-\label{man/mount::doc}\label{man/mount:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} command}
+\label{\detokenize{man/mount:the-command-command}}\label{\detokenize{man/mount::doc}}
\subsection{Synopsis}
-\label{man/mount:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/mount:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{mount.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mount point\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/mount:description}
-The \textbf{\texttt{mount.s3ql}} command mounts the S3QL file system stored in \emph{storage
-url} in the directory \emph{mount point}. The storage url depends on the
-backend that is used. The S3QL User's Guide should be consulted for a
+\label{\detokenize{man/mount:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} command mounts the S3QL file system stored in \sphinxstyleemphasis{storage
+url} in the directory \sphinxstyleemphasis{mount point}. The storage url depends on the
+backend that is used. The S3QL User’s Guide should be consulted for a
description of the available backends.
\subsection{Options}
-\label{man/mount:options}
-The \textbf{\texttt{mount.s3ql}} command accepts the following options.
+\label{\detokenize{man/mount:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} command accepts the following options.
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}log \textless{}target\textgreater{}]
-Destination for log messages. Specify \sphinxcode{none} for
-standard output or \sphinxcode{syslog} for the system logging
+Destination for log messages. Specify \sphinxcode{\sphinxupquote{none}} for
+standard output or \sphinxcode{\sphinxupquote{syslog}} for the system logging
daemon. Anything else will be interpreted as a file
name. Log files will be rotated when they reach 1 MiB,
and at most 5 old log files will be kept. Default:
-\sphinxcode{\textasciitilde{}/.s3ql/mount.log}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/mount.log}}
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}backend-options \textless{}options\textgreater{}]
@@ -2831,7 +3098,7 @@ backend documentation for available options.
just print program version and exit
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-{-}cachesize \textless{}size\textgreater{}]
Cache size in KiB (default: autodetect).
\item [-{-}max-cache-entries \textless{}num\textgreater{}]
@@ -2839,20 +3106,20 @@ Maximum number of entries in cache (default:
autodetect). Each cache entry requires one file
descriptor, so if you increase this number you have to
make sure that your process file descriptor limit (as
-set with \sphinxcode{ulimit -n}) is high enough (at least the
+set with \sphinxcode{\sphinxupquote{ulimit -n}}) is high enough (at least the
number of cache entries + 100).
\item [-{-}keep-cache]
Do not purge locally cached files on exit.
\item [-{-}allow-other]
-Normally, only the user who called \sphinxcode{mount.s3ql} can
+Normally, only the user who called \sphinxcode{\sphinxupquote{mount.s3ql}} can
access the mount point. This user then also has full
access to it, independent of individual file
-permissions. If the \sphinxcode{-{-}allow-other} option is
+permissions. If the \sphinxcode{\sphinxupquote{-{-}allow-other}} option is
specified, other users can access the mount point as
well and individual file permissions are taken into
account for all users.
\item [-{-}allow-root]
-Like \sphinxcode{-{-}allow-other}, but restrict access to the
+Like \sphinxcode{\sphinxupquote{-{-}allow-other}}, but restrict access to the
mounting user and the root user.
\item [-{-}fg]
Do not daemonize, stay in foreground
@@ -2861,10 +3128,10 @@ Stay in foreground and raise SIGSTOP once mountpoint
is up.
\item [-{-}compress \textless{}algorithm-lvl\textgreater{}]
Compression algorithm and compression level to use
-when storing new data. \emph{algorithm} may be any of
-\sphinxcode{lzma}, \sphinxcode{bzip2}, \sphinxcode{zlib}, or none. \emph{lvl} may be any
+when storing new data. \sphinxstyleemphasis{algorithm} may be any of
+\sphinxcode{\sphinxupquote{lzma}}, \sphinxcode{\sphinxupquote{bzip2}}, \sphinxcode{\sphinxupquote{zlib}}, or none. \sphinxstyleemphasis{lvl} may be any
integer from 0 (fastest) to 9 (slowest). Default:
-\sphinxcode{lzma-6}
+\sphinxcode{\sphinxupquote{lzma-6}}
\item [-{-}metadata-upload-interval \textless{}seconds\textgreater{}]
Interval in seconds between complete metadata uploads.
Set to 0 to disable. Default: 24h.
@@ -2879,8 +3146,8 @@ system over NFS. (default: False)
\subsection{Exit Codes}
-\label{man/mount:exit-codes}
-\textbf{\texttt{mount.s3ql}} may terminate with the following exit codes:
+\label{\detokenize{man/mount:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -2923,7 +3190,7 @@ Wrong file system passphrase.
No S3QL file system found at given storage URL.
\item[{19}] \leavevmode
-Unable to connect to backend, can't resolve hostname.
+Unable to connect to backend, can’t resolve hostname.
\item[{30}] \leavevmode
File system was not unmounted cleanly.
@@ -2938,7 +3205,7 @@ Unsupported file system revision (too old).
Unsupported file system revision (too new).
\item[{34}] \leavevmode
-Insufficient free nodes, need to run \textbf{\texttt{fsck.s3ql}}.
+Insufficient free nodes, need to run \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}}.
\item[{35}] \leavevmode
Attempted to mount read-only, this is not supported.
@@ -2959,48 +3226,49 @@ Unable to access cache directory.
\subsection{See Also}
-\label{man/mount:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/mount:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{s3qlstat}} command}
-\label{man/stat::doc}\label{man/stat:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{s3qlstat}} command}
+\label{\detokenize{man/stat:the-command-command}}\label{\detokenize{man/stat::doc}}
\subsection{Synopsis}
-\label{man/stat:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/stat:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qlstat }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mountpoint\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/stat:description}
-The \textbf{\texttt{s3qlstat}} command prints statistics about the S3QL file system mounted
-at \sphinxcode{mountpoint}.
+\label{\detokenize{man/stat:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qlstat}} command prints statistics about the S3QL file system mounted
+at \sphinxcode{\sphinxupquote{mountpoint}}.
-\textbf{\texttt{s3qlstat}} can only be called by the user that mounted the file system
-and (if the file system was mounted with \sphinxcode{-{-}allow-other} or
-\sphinxcode{-{-}allow-root}) the root user.
+\sphinxstyleliteralstrong{\sphinxupquote{s3qlstat}} can only be called by the user that mounted the file system
+and (if the file system was mounted with \sphinxcode{\sphinxupquote{-{-}allow-other}} or
+\sphinxcode{\sphinxupquote{-{-}allow-root}}) the root user.
\subsection{Options}
-\label{man/stat:options}
-The \textbf{\texttt{s3qlstat}} command accepts the following options:
+\label{\detokenize{man/stat:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qlstat}} command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
@@ -3012,8 +3280,8 @@ Do not pretty-print numbers
\subsection{Exit Codes}
-\label{man/stat:exit-codes}
-\textbf{\texttt{s3qlstat}} may terminate with the following exit codes:
+\label{\detokenize{man/stat:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{s3qlstat}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -3029,36 +3297,37 @@ Invalid command line argument or configuration file key.
\subsection{See Also}
-\label{man/stat:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/stat:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{s3qlctrl}} command}
-\label{man/ctrl::doc}\label{man/ctrl:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{s3qlctrl}} command}
+\label{\detokenize{man/ctrl:the-command-command}}\label{\detokenize{man/ctrl::doc}}
\subsection{Synopsis}
-\label{man/ctrl:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/ctrl:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qlctrl }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}action\PYGZgt{}}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mountpoint\PYGZgt{}}\PYG{l}{ ...}
-\end{Verbatim}
+\end{sphinxVerbatim}
-where \sphinxcode{action} may be either of \textbf{\texttt{flushcache}},
-\textbf{\texttt{upload-meta}}, \textbf{\texttt{cachesize}} or
-\textbf{\texttt{log-metadata}}.
+where \sphinxcode{\sphinxupquote{action}} may be either of \sphinxstyleliteralstrong{\sphinxupquote{flushcache}},
+\sphinxstyleliteralstrong{\sphinxupquote{upload-meta}}, \sphinxstyleliteralstrong{\sphinxupquote{cachesize}} or
+\sphinxstyleliteralstrong{\sphinxupquote{log-metadata}}.
\subsection{Description}
-\label{man/ctrl:description}
-The \textbf{\texttt{s3qlctrl}} command performs various actions on the S3QL file system mounted
-in \sphinxcode{mountpoint}.
+\label{\detokenize{man/ctrl:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qlctrl}} command performs various actions on the S3QL file system mounted
+in \sphinxcode{\sphinxupquote{mountpoint}}.
-\textbf{\texttt{s3qlctrl}} can only be called by the user that mounted the file system
-and (if the file system was mounted with \sphinxcode{-{-}allow-other} or
-\sphinxcode{-{-}allow-root}) the root user.
+\sphinxstyleliteralstrong{\sphinxupquote{s3qlctrl}} can only be called by the user that mounted the file system
+and (if the file system was mounted with \sphinxcode{\sphinxupquote{-{-}allow-other}} or
+\sphinxcode{\sphinxupquote{-{-}allow-root}}) the root user.
The following actions may be specified:
\begin{description}
@@ -3080,29 +3349,31 @@ Changes the cache size of the file system. This action requires an
additional argument that specifies the new cache size in KiB, so the
complete command line is:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qlctrl }\PYG{g+ge}{[options]}\PYG{l}{ cachesize }\PYG{n+nv}{\PYGZlt{}mountpoint\PYGZgt{}}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}new\PYGZhy{}cache\PYGZhy{}size\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\item[{log}] \leavevmode
Change the amount of information that is logged into
-\sphinxcode{\textasciitilde{}/.s3ql/mount.log} file. The complete syntax is:
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/mount.log}} file. The complete syntax is:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
s3qlctrl [options] log \PYGZlt{}mountpoint\PYGZgt{} \PYGZlt{}level\PYGZgt{} [\PYGZlt{}module\PYGZgt{} [\PYGZlt{}module\PYGZgt{} ...]]
-\end{Verbatim}
+\end{sphinxVerbatim}
-here \sphinxcode{level} is the desired new log level and may be either of
-\emph{debug}, \emph{info} or \emph{warn}. One or more \sphinxcode{module} may only be
-specified with the \emph{debug} level and allow to restrict the debug
+here \sphinxcode{\sphinxupquote{level}} is the desired new log level and may be either of
+\sphinxstyleemphasis{debug}, \sphinxstyleemphasis{info} or \sphinxstyleemphasis{warn}. One or more \sphinxcode{\sphinxupquote{module}} may only be
+specified with the \sphinxstyleemphasis{debug} level and allow to restrict the debug
output to just the listed modules.
\end{description}
\subsection{Options}
-\label{man/ctrl:options}
-The \textbf{\texttt{s3qlctrl}} command also accepts the following options, no matter
+\label{\detokenize{man/ctrl:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qlctrl}} command also accepts the following options, no matter
what specific action is being invoked:
\begin{quote}
\begin{optionlist}{3cm}
@@ -3110,11 +3381,11 @@ what specific action is being invoked:
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
@@ -3122,13 +3393,13 @@ just print program version and exit
\end{optionlist}
\end{quote}
-Hint: run \sphinxcode{s3qlctrl \textless{}action\textgreater{} -{-}help} to get help on the additional arguments
+Hint: run \sphinxcode{\sphinxupquote{s3qlctrl \textless{}action\textgreater{} -{-}help}} to get help on the additional arguments
that the different actions take.
\subsection{Exit Codes}
-\label{man/ctrl:exit-codes}
-\textbf{\texttt{s3qlctrl}} may terminate with the following exit codes:
+\label{\detokenize{man/ctrl:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{s3qlctrl}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -3144,56 +3415,57 @@ Invalid command line argument or configuration file key.
\subsection{See Also}
-\label{man/ctrl:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/ctrl:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{s3qlcp}} command}
-\label{man/cp::doc}\label{man/cp:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{s3qlcp}} command}
+\label{\detokenize{man/cp:the-command-command}}\label{\detokenize{man/cp::doc}}
\subsection{Synopsis}
-\label{man/cp:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/cp:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qlcp }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}source\PYGZhy{}dir\PYGZgt{}}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}dest\PYGZhy{}dir\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/cp:description}
-The \textbf{\texttt{s3qlcp}} command duplicates the directory tree \sphinxcode{source-dir}
-into \sphinxcode{dest-dir} without physically copying the file contents.
+\label{\detokenize{man/cp:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qlcp}} command duplicates the directory tree \sphinxcode{\sphinxupquote{source-dir}}
+into \sphinxcode{\sphinxupquote{dest-dir}} without physically copying the file contents.
Both source and destination must lie inside the same S3QL file system.
The replication will not take any additional space. Only if one of
directories is modified later on, the modified data will take
additional storage space.
-\sphinxcode{s3qlcp} can only be called by the user that mounted the file system
-and (if the file system was mounted with \sphinxcode{-{-}allow-other} or \sphinxcode{-{-}allow-root})
+\sphinxcode{\sphinxupquote{s3qlcp}} can only be called by the user that mounted the file system
+and (if the file system was mounted with \sphinxcode{\sphinxupquote{-{-}allow-other}} or \sphinxcode{\sphinxupquote{-{-}allow-root}})
the root user.
Note that:
\begin{itemize}
\item {}
After the replication, both source and target directory will still
-be completely ordinary directories. You can regard \sphinxcode{\textless{}src\textgreater{}} as a
-snapshot of \sphinxcode{\textless{}target\textgreater{}} or vice versa. However, the most common
-usage of \sphinxcode{s3qlcp} is to regularly duplicate the same source
-directory, say \sphinxcode{documents}, to different target directories. For a
+be completely ordinary directories. You can regard \sphinxcode{\sphinxupquote{\textless{}src\textgreater{}}} as a
+snapshot of \sphinxcode{\sphinxupquote{\textless{}target\textgreater{}}} or vice versa. However, the most common
+usage of \sphinxcode{\sphinxupquote{s3qlcp}} is to regularly duplicate the same source
+directory, say \sphinxcode{\sphinxupquote{documents}}, to different target directories. For a
e.g. monthly replication, the target directories would typically be
-named something like \sphinxcode{documents\_January} for the replication in
-January, \sphinxcode{documents\_February} for the replication in February etc.
+named something like \sphinxcode{\sphinxupquote{documents\_January}} for the replication in
+January, \sphinxcode{\sphinxupquote{documents\_February}} for the replication in February etc.
In this case it is clear that the target directories should be
regarded as snapshots of the source directory.
\item {}
Exactly the same effect could be achieved by an ordinary copy
-program like \sphinxcode{cp -a}. However, this procedure would be orders of
-magnitude slower, because \sphinxcode{cp} would have to read every file
+program like \sphinxcode{\sphinxupquote{cp -a}}. However, this procedure would be orders of
+magnitude slower, because \sphinxcode{\sphinxupquote{cp}} would have to read every file
completely (so that S3QL had to fetch all the data over the network
from the backend) before writing them into the destination folder.
@@ -3201,10 +3473,10 @@ from the backend) before writing them into the destination folder.
\subsubsection{Snapshotting vs Hardlinking}
-\label{man/cp:snapshotting-vs-hardlinking}
+\label{\detokenize{man/cp:snapshotting-vs-hardlinking}}
Snapshot support in S3QL is inspired by the hardlinking feature that
-is offered by programs like \href{http://www.samba.org/rsync}{rsync} or
-\href{http://savannah.nongnu.org/projects/storebackup}{storeBackup}.
+is offered by programs like \sphinxhref{http://www.samba.org/rsync}{rsync} or
+\sphinxhref{http://savannah.nongnu.org/projects/storebackup}{storeBackup}.
These programs can create a hardlink instead of copying a file if an
identical file already exists in the backup. However, using hardlinks
has two large disadvantages:
@@ -3227,19 +3499,19 @@ any backup program.
\subsection{Options}
-\label{man/cp:options}
-The \textbf{\texttt{s3qlcp}} command accepts the following options:
+\label{\detokenize{man/cp:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qlcp}} command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
@@ -3249,8 +3521,8 @@ just print program version and exit
\subsection{Exit Codes}
-\label{man/cp:exit-codes}
-\textbf{\texttt{s3qlcp}} may terminate with the following exit codes:
+\label{\detokenize{man/cp:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{s3qlcp}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -3266,54 +3538,55 @@ Invalid command line argument or configuration file key.
\subsection{See Also}
-\label{man/cp:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/cp:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{s3qlrm}} command}
-\label{man/rm::doc}\label{man/rm:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{s3qlrm}} command}
+\label{\detokenize{man/rm:the-command-command}}\label{\detokenize{man/rm::doc}}
\subsection{Synopsis}
-\label{man/rm:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/rm:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qlrm }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}directory\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/rm:description}
-The \textbf{\texttt{s3qlrm}} command recursively deletes files and directories on an
-S3QL file system. Although \textbf{\texttt{s3qlrm}} is faster than using e.g.
-\textbf{\texttt{rm -r{}`}}, the main reason for its existence is that it allows
+\label{\detokenize{man/rm:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qlrm}} command recursively deletes files and directories on an
+S3QL file system. Although \sphinxstyleliteralstrong{\sphinxupquote{s3qlrm}} is faster than using e.g.
+\sphinxstyleliteralstrong{\sphinxupquote{rm -r{}`}}, the main reason for its existence is that it allows
you to delete immutable trees (which can be created with
-\textbf{\texttt{s3qllock}}) as well.
+\sphinxstyleliteralstrong{\sphinxupquote{s3qllock}}) as well.
Be warned that there is no additional confirmation. The directory will
be removed entirely and immediately.
-\textbf{\texttt{s3qlrm}} can only be called by the user that mounted the file system
-and (if the file system was mounted with \sphinxcode{-{-}allow-other} or
-\sphinxcode{-{-}allow-root}) the root user.
+\sphinxstyleliteralstrong{\sphinxupquote{s3qlrm}} can only be called by the user that mounted the file system
+and (if the file system was mounted with \sphinxcode{\sphinxupquote{-{-}allow-other}} or
+\sphinxcode{\sphinxupquote{-{-}allow-root}}) the root user.
\subsection{Options}
-\label{man/rm:options}
-The \textbf{\texttt{s3qlrm}} command accepts the following options:
+\label{\detokenize{man/rm:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qlrm}} command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
@@ -3323,8 +3596,8 @@ just print program version and exit
\subsection{Exit Codes}
-\label{man/rm:exit-codes}
-\textbf{\texttt{s3qlrm}} may terminate with the following exit codes:
+\label{\detokenize{man/rm:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{s3qlrm}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -3340,39 +3613,40 @@ Invalid command line argument or configuration file key.
\subsection{See Also}
-\label{man/rm:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/rm:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{s3qllock}} command}
-\label{man/lock::doc}\label{man/lock:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{s3qllock}} command}
+\label{\detokenize{man/lock:the-command-command}}\label{\detokenize{man/lock::doc}}
\subsection{Synopsis}
-\label{man/lock:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/lock:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3qllock }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}directory\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/lock:description}
-The \textbf{\texttt{s3qllock}} command makes a directory tree in an S3QL file
+\label{\detokenize{man/lock:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qllock}} command makes a directory tree in an S3QL file
system immutable. Immutable trees can no longer be changed in any way
whatsoever. You can not add new files or directories and you can not
change or delete existing files and directories. The only way to get
-rid of an immutable tree is to use the \textbf{\texttt{s3qlrm}} command.
+rid of an immutable tree is to use the \sphinxstyleliteralstrong{\sphinxupquote{s3qlrm}} command.
-\textbf{\texttt{s3qllock}} can only be called by the user that mounted the file system
-and (if the file system was mounted with \sphinxcode{-{-}allow-other} or
-\sphinxcode{-{-}allow-root}) the root user.
+\sphinxstyleliteralstrong{\sphinxupquote{s3qllock}} can only be called by the user that mounted the file system
+and (if the file system was mounted with \sphinxcode{\sphinxupquote{-{-}allow-other}} or
+\sphinxcode{\sphinxupquote{-{-}allow-root}}) the root user.
\subsection{Rationale}
-\label{man/lock:rationale}
+\label{\detokenize{man/lock:rationale}}
Immutability is a feature designed for backups. Traditionally, backups
have been made on external tape drives. Once a backup was made, the
tape drive was removed and locked somewhere in a shelf. This has the
@@ -3385,7 +3659,7 @@ all backups are available every time the file system is mounted.
Nothing prevents a file in an old backup from being changed again
later on. In the worst case, this may make your entire backup system
worthless. Imagine that your system gets infected by a nasty virus
-that simply deletes all files it can find -- if the virus is active
+that simply deletes all files it can find \textendash{} if the virus is active
while the backup file system is mounted, the virus will destroy all
your old backups as well!
@@ -3393,9 +3667,9 @@ Even if the possibility of a malicious virus or trojan horse is
excluded, being able to change a backup after it has been made is
generally not a good idea. A common S3QL use case is to keep the file
system mounted at all times and periodically create backups with
-\textbf{\texttt{rsync -a}}. This allows every user to recover her files from a
+\sphinxstyleliteralstrong{\sphinxupquote{rsync -a}}. This allows every user to recover her files from a
backup without having to call the system administrator. However, this
-also allows every user to accidentally change or delete files \emph{in} one
+also allows every user to accidentally change or delete files \sphinxstyleemphasis{in} one
of the old backups.
Making a backup immutable protects you against all these problems.
@@ -3405,19 +3679,19 @@ changed after they have been made immutable.
\subsection{Options}
-\label{man/lock:options}
-The \textbf{\texttt{s3qllock}} command accepts the following options:
+\label{\detokenize{man/lock:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3qllock}} command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
@@ -3427,8 +3701,8 @@ just print program version and exit
\subsection{Exit Codes}
-\label{man/lock:exit-codes}
-\textbf{\texttt{s3qllock}} may terminate with the following exit codes:
+\label{\detokenize{man/lock:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{s3qllock}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -3444,54 +3718,55 @@ Invalid command line argument or configuration file key.
\subsection{See Also}
-\label{man/lock:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/lock:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{umount.s3ql}} command}
-\label{man/umount::doc}\label{man/umount:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{umount.s3ql}} command}
+\label{\detokenize{man/umount:the-command-command}}\label{\detokenize{man/umount::doc}}
\subsection{Synopsis}
-\label{man/umount:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/umount:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{umount.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mount point\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/umount:description}
-The \textbf{\texttt{umount.s3ql}} command unmounts the S3QL file system mounted in the
-directory \emph{mount point} and blocks until all data has been uploaded to
+\label{\detokenize{man/umount:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{umount.s3ql}} command unmounts the S3QL file system mounted in the
+directory \sphinxstyleemphasis{mount point} and blocks until all data has been uploaded to
the storage backend.
-Only the user who mounted the file system with \textbf{\texttt{mount.s3ql}}
-is able to unmount it with \textbf{\texttt{umount.s3ql}}. If you are root and want to
+Only the user who mounted the file system with \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}}
+is able to unmount it with \sphinxstyleliteralstrong{\sphinxupquote{umount.s3ql}}. If you are root and want to
unmount an S3QL file system mounted by an ordinary user, you have to
-use the \textbf{\texttt{fusermount -u}} or \textbf{\texttt{umount}} command instead.
+use the \sphinxstyleliteralstrong{\sphinxupquote{fusermount -u}} or \sphinxstyleliteralstrong{\sphinxupquote{umount}} command instead.
Note that these commands do not block until all data has been
-uploaded, so if you use them instead of \textbf{\texttt{umount.s3ql}} then
-you should manually wait for the \textbf{\texttt{mount.s3ql}} process to
+uploaded, so if you use them instead of \sphinxstyleliteralstrong{\sphinxupquote{umount.s3ql}} then
+you should manually wait for the \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} process to
terminate before shutting down the system.
\subsection{Options}
-\label{man/umount:options}
-The \textbf{\texttt{umount.s3ql}} command accepts the following options.
+\label{\detokenize{man/umount:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{umount.s3ql}} command accepts the following options.
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
@@ -3506,8 +3781,8 @@ been closed.
\subsection{Exit Codes}
-\label{man/umount:exit-codes}
-\textbf{\texttt{umount.s3ql}} may terminate with the following exit codes:
+\label{\detokenize{man/umount:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{umount.s3ql}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -3523,56 +3798,57 @@ Invalid command line argument or configuration file key.
\subsection{See Also}
-\label{man/umount:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/umount:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{fsck.s3ql}} command}
-\label{man/fsck::doc}\label{man/fsck:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} command}
+\label{\detokenize{man/fsck:the-command-command}}\label{\detokenize{man/fsck::doc}}
\subsection{Synopsis}
-\label{man/fsck:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/fsck:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{fsck.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/fsck:description}
-The \textbf{\texttt{fsck.s3ql}} command checks the file system in the location specified
-by \emph{storage url} for errors and attempts to repair any problems. The
-storage url depends on the backend that is used. The S3QL User's Guide
+\label{\detokenize{man/fsck:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} command checks the file system in the location specified
+by \sphinxstyleemphasis{storage url} for errors and attempts to repair any problems. The
+storage url depends on the backend that is used. The S3QL User’s Guide
should be consulted for a description of the available backends.
\subsection{Options}
-\label{man/fsck:options}
-The \textbf{\texttt{fsck.s3ql}} command accepts the following options.
+\label{\detokenize{man/fsck:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} command accepts the following options.
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}log \textless{}target\textgreater{}]
-Destination for log messages. Specify \sphinxcode{none} for
-standard output or \sphinxcode{syslog} for the system logging
+Destination for log messages. Specify \sphinxcode{\sphinxupquote{none}} for
+standard output or \sphinxcode{\sphinxupquote{syslog}} for the system logging
daemon. Anything else will be interpreted as a file
name. Log files will be rotated when they reach 1 MiB,
and at most 5 old log files will be kept. Default:
-\sphinxcode{\textasciitilde{}/.s3ql/fsck.log}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/fsck.log}}
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}backend-options \textless{}options\textgreater{}]
@@ -3582,7 +3858,7 @@ backend documentation for available options.
just print program version and exit
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-{-}keep-cache]
Do not purge locally cached files on exit.
\item [-{-}batch]
@@ -3597,8 +3873,8 @@ likely result in data loss.
\subsection{Exit Codes}
-\label{man/fsck:exit-codes}
-If \textbf{\texttt{fsck.s3ql}} found any file system errors (no matter if they were
+\label{\detokenize{man/fsck:exit-codes}}
+If \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} found any file system errors (no matter if they were
corrected or not), the exit code will be 128 plus one of the codes
listed below. If no errors were found, the following exit codes are
used as-is:
@@ -3644,7 +3920,7 @@ Wrong file system passphrase.
No S3QL file system found at given storage URL.
\item[{19}] \leavevmode
-Unable to connect to backend, can't resolve hostname.
+Unable to connect to backend, can’t resolve hostname.
\item[{32}] \leavevmode
Unsupported file system revision (too old).
@@ -3671,7 +3947,7 @@ Uncorrectable errors found.
Unable to access cache directory.
\item[{128}] \leavevmode
-This error code will be \emph{added} to one of the codes above if any
+This error code will be \sphinxstyleemphasis{added} to one of the codes above if any
file system errors have been found (no matter if they were
corrected or not).
@@ -3679,52 +3955,53 @@ corrected or not).
\subsection{See Also}
-\label{man/fsck:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/fsck:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{s3ql\_oauth\_client}} command}
-\label{man/oauth_client:oauth-client}\label{man/oauth_client::doc}\label{man/oauth_client:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_oauth\_client}} command}
+\label{\detokenize{man/oauth_client:the-command-command}}\label{\detokenize{man/oauth_client:oauth-client}}\label{\detokenize{man/oauth_client::doc}}
\subsection{Synopsis}
-\label{man/oauth_client:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/oauth_client:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3ql\PYGZus{}oauth\PYGZus{}client }\PYG{g+ge}{[options]}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/oauth_client:description}
-The \textbf{\texttt{s3ql\_oauth\_client}} command may be used to obtain OAuth2 authentication
-tokens for use with Google Storage. It requests ``user code'' from
+\label{\detokenize{man/oauth_client:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_oauth\_client}} command may be used to obtain OAuth2 authentication
+tokens for use with Google Storage. It requests “user code” from
Google which has to be pasted into the browser to complete the
authentication process interactively. Once authentication in the
-browser has been completed, \textbf{\texttt{s3ql\_oauth\_client}} displays the OAuth2 refresh
+browser has been completed, \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_oauth\_client}} displays the OAuth2 refresh
token.
-When combined with the special username \sphinxcode{oauth2}, the refresh token
+When combined with the special username \sphinxcode{\sphinxupquote{oauth2}}, the refresh token
can be used as a backend passphrase when using the Google Storage S3QL
backend.
\subsection{Options}
-\label{man/oauth_client:options}
-The \textbf{\texttt{s3ql\_oauth\_client}} command accepts the following options:
+\label{\detokenize{man/oauth_client:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_oauth\_client}} command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
@@ -3734,8 +4011,8 @@ just print program version and exit
\subsection{Exit Codes}
-\label{man/oauth_client:exit-codes}
-\textbf{\texttt{s3ql\_oauth\_client}} may terminate with the following exit codes:
+\label{\detokenize{man/oauth_client:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{s3ql\_oauth\_client}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -3751,63 +4028,64 @@ Invalid command line argument or configuration file key.
\subsection{See Also}
-\label{man/oauth_client:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/oauth_client:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{s3ql\_verify}} command}
-\label{man/verify::doc}\label{man/verify:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} command}
+\label{\detokenize{man/verify:the-command-command}}\label{\detokenize{man/verify::doc}}
\subsection{Synopsis}
-\label{man/verify:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/verify:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{s3ql\PYGZus{}verify }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/verify:description}
-The \textbf{\texttt{s3ql\_verify}} command verifies all data in the file system. In
-contrast to \textbf{\texttt{fsck.s3ql}}, \textbf{\texttt{s3ql\_verify}} does not trust the object
+\label{\detokenize{man/verify:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} command verifies all data in the file system. In
+contrast to \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}}, \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} does not trust the object
listing returned by the backend, but actually attempts to retrieve
every object. It therefore takes a lot longer.
-The format of \sphinxcode{\textless{}storage url\textgreater{}} depends on the backend that is
-used. The S3QL User's Guide should be consulted for a description of
+The format of \sphinxcode{\sphinxupquote{\textless{}storage url\textgreater{}}} depends on the backend that is
+used. The S3QL User’s Guide should be consulted for a description of
the available backends.
\subsection{Options}
-\label{man/verify:options}
-The \textbf{\texttt{s3ql\_verify}} command accepts the following options.
+\label{\detokenize{man/verify:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} command accepts the following options.
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}debug-modules \textless{}modules\textgreater{}]
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}quiet]
be really quiet
\item [-{-}version]
just print program version and exit
\item [-{-}cachedir \textless{}path\textgreater{}]
Store cached data in this directory (default:
-\sphinxcode{\textasciitilde{}/.s3ql)}
+\sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql)}}
\item [-{-}backend-options \textless{}options\textgreater{}]
Backend specific options (separate by commas). See
backend documentation for available options.
\item [-{-}authfile \textless{}path\textgreater{}]
Read authentication credentials from this file
-(default: \sphinxcode{\textasciitilde{}/.s3ql/authinfo2)}
+(default: \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2)}}
\item [-{-}missing-file \textless{}name\textgreater{}]
File to store keys of missing objects.
\item [-{-}corrupted-file \textless{}name\textgreater{}]
@@ -3825,8 +4103,8 @@ Skip over first \textless{}n\textgreater{} objects and with verifying object
\subsection{Exit Codes}
-\label{man/verify:exit-codes}
-\textbf{\texttt{s3ql\_verify}} may terminate with the following exit codes:
+\label{\detokenize{man/verify:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -3869,7 +4147,7 @@ Wrong file system passphrase.
No S3QL file system found at given storage URL.
\item[{19}] \leavevmode
-Unable to connect to backend, can't resolve hostname.
+Unable to connect to backend, can’t resolve hostname.
\item[{32}] \leavevmode
Unsupported file system revision (too old).
@@ -3888,39 +4166,40 @@ to be missing or corrupted.
\subsection{See Also}
-\label{man/verify:see-also}
-The S3QL homepage is at \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/verify:see-also}}
+The S3QL homepage is at \sphinxurl{https://github.com/s3ql/s3ql/}.
The full S3QL documentation should also be installed somewhere on your
-system, common locations are \sphinxcode{/usr/share/doc/s3ql} or
-\sphinxcode{/usr/local/doc/s3ql}.
+system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or
+\sphinxcode{\sphinxupquote{/usr/local/doc/s3ql}}.
-\section{The \textbf{\texttt{pcp}} command}
-\label{man/pcp::doc}\label{man/pcp:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{pcp}} command}
+\label{\detokenize{man/pcp:the-command-command}}\label{\detokenize{man/pcp::doc}}
\subsection{Synopsis}
-\label{man/pcp:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/pcp:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{pcp }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}source\PYGZgt{}}\PYG{l}{ }\PYG{g+ge}{[\PYGZlt{}source\PYGZgt{} ...]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}destination\PYGZgt{}}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/pcp:description}
-The \textbf{\texttt{pcp}} command is a is a wrapper that starts several
-\textbf{\texttt{sync}} processes to copy directory trees in parallel. This is
+\label{\detokenize{man/pcp:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{pcp}} command is a is a wrapper that starts several
+\sphinxstyleliteralstrong{\sphinxupquote{sync}} processes to copy directory trees in parallel. This is
allows much better copying performance on file system that have
relatively high latency when retrieving individual files like S3QL.
-\textbf{Note}: Using this program only improves performance when copying
-\emph{from} an S3QL file system. When copying \emph{to} an S3QL file system,
-using \textbf{\texttt{pcp}} is more likely to \emph{decrease} performance.
+\sphinxstylestrong{Note}: Using this program only improves performance when copying
+\sphinxstyleemphasis{from} an S3QL file system. When copying \sphinxstyleemphasis{to} an S3QL file system,
+using \sphinxstyleliteralstrong{\sphinxupquote{pcp}} is more likely to \sphinxstyleemphasis{decrease} performance.
\subsection{Options}
-\label{man/pcp:options}
-The \textbf{\texttt{pcp}} command accepts the following options:
+\label{\detokenize{man/pcp:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{pcp}} command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}quiet]
@@ -3929,11 +4208,11 @@ be really quiet
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}version]
just print program version and exit
\item [-a]
@@ -3945,8 +4224,8 @@ Number of rsync processes to use (default: 10).
\subsection{Exit Codes}
-\label{man/pcp:exit-codes}
-\textbf{\texttt{pcp}} may terminate with the following exit codes:
+\label{\detokenize{man/pcp:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{pcp}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -3962,27 +4241,28 @@ Invalid command line argument or configuration file key.
\subsection{See Also}
-\label{man/pcp:see-also}
-\textbf{\texttt{pcp}} is shipped as part of S3QL, \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/pcp:see-also}}
+\sphinxstyleliteralstrong{\sphinxupquote{pcp}} is shipped as part of S3QL, \sphinxurl{https://github.com/s3ql/s3ql/}.
-\section{The \textbf{\texttt{expire\_backups}} command}
-\label{man/expire_backups::doc}\label{man/expire_backups:the-command-command}
+\section{The \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} command}
+\label{\detokenize{man/expire_backups:the-command-command}}\label{\detokenize{man/expire_backups::doc}}
\subsection{Synopsis}
-\label{man/expire_backups:synopsis}
-\begin{Verbatim}[commandchars=\\\{\}]
+\label{\detokenize{man/expire_backups:synopsis}}
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{expire\PYGZus{}backups }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}age\PYGZgt{}}\PYG{l}{ }\PYG{g+ge}{[\PYGZlt{}age\PYGZgt{} ...]}
-\end{Verbatim}
+\end{sphinxVerbatim}
\subsection{Description}
-\label{man/expire_backups:description}
-The \textbf{\texttt{expire\_backups}} command intelligently remove old backups that are no
+\label{\detokenize{man/expire_backups:description}}
+The \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} command intelligently remove old backups that are no
longer needed.
To define what backups you want to keep for how long, you define a
-number of \emph{age ranges}. \textbf{\texttt{expire\_backups}} ensures that you
+number of \sphinxstyleemphasis{age ranges}. \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} ensures that you
will have at least one backup in each age range at all times. It will
keep exactly as many backups as are required for that and delete any
backups that become redundant.
@@ -3991,10 +4271,13 @@ Age ranges are specified by giving a list of range boundaries in terms
of backup cycles. Every time you create a new backup, the existing
backups age by one cycle.
-Example: when \textbf{\texttt{expire\_backups}} is called with the age range
-definition \sphinxcode{1 3 7 14 31}, it will guarantee that you always have the
+Example: when \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} is called with the age range
+definition \sphinxcode{\sphinxupquote{1 3 7 14 31}}, it will guarantee that you always have the
following backups available:
\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
\item {}
A backup that is 0 to 1 cycles old (i.e, the most recent backup)
@@ -4012,7 +4295,7 @@ A backup that is 14 to 31 cycles old
\end{enumerate}
-\begin{notice}{note}{Note:}
+\begin{sphinxadmonition}{note}{Note:}
If you do backups in fixed intervals, then one cycle will be
equivalent to the backup interval. The advantage of specifying the
age ranges in terms of backup cycles rather than days or weeks is
@@ -4022,40 +4305,41 @@ one month. Now all your backups are at least a month old, and if you
had specified the above backup strategy in terms of absolute ages,
they would all be deleted! Specifying age ranges in terms of backup
cycles avoids these sort of problems.
-\end{notice}
+\end{sphinxadmonition}
-\textbf{\texttt{expire\_backups}} usage is simple. It requires backups to be
-stored in directories of the form \sphinxcode{year-month-day\_hour:minute:seconds}
-(\sphinxcode{YYYY-MM-DD\_HH:mm:ss}) and works on all backups in the current
+\sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} usage is simple. It requires backups to be
+stored in directories of the form \sphinxcode{\sphinxupquote{year-month-day\_hour:minute:seconds}}
+(\sphinxcode{\sphinxupquote{YYYY-MM-DD\_HH:mm:ss}}) and works on all backups in the current
directory. So for the above backup strategy, the correct invocation
would be:
-\begin{Verbatim}[commandchars=\\\{\}]
+\fvset{hllines={, ,}}%
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{l}{expire\PYGZus{}backups.py 1 3 7 14 31}
-\end{Verbatim}
+\end{sphinxVerbatim}
When storing your backups on an S3QL file system, you probably want to
-specify the \sphinxcode{-{-}use-s3qlrm} option as well. This tells
-\textbf{\texttt{expire\_backups}} to use the {\hyperref[special:s3qlrm]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlrm}}}} command to
+specify the \sphinxcode{\sphinxupquote{-{-}use-s3qlrm}} option as well. This tells
+\sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} to use the {\hyperref[\detokenize{special:s3qlrm}]{\sphinxcrossref{\DUrole{std,std-ref}{s3qlrm}}}} command to
delete directories.
-\textbf{\texttt{expire\_backups}} uses a ``state file'' to keep track which
+\sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} uses a “state file” to keep track which
backups are how many cycles old (since this cannot be inferred from
the dates contained in the directory names). The standard name for
-this state file is \sphinxcode{.expire\_backups.dat}. If this file gets
-damaged or deleted, \textbf{\texttt{expire\_backups}} no longer knows the ages
+this state file is \sphinxcode{\sphinxupquote{.expire\_backups.dat}}. If this file gets
+damaged or deleted, \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} no longer knows the ages
of the backups and refuses to work. In this case you can use the
-\sphinxcode{-{-}reconstruct-state} option to try to reconstruct the state
+\sphinxcode{\sphinxupquote{-{-}reconstruct-state}} option to try to reconstruct the state
from the backup dates. However, the accuracy of this reconstruction
depends strongly on how rigorous you have been with making backups (it
is only completely correct if the time between subsequent backups has
-always been exactly the same), so it's generally a good idea not to
+always been exactly the same), so it’s generally a good idea not to
tamper with the state file.
\subsection{Options}
-\label{man/expire_backups:options}
-The \textbf{\texttt{expire\_backups}} command accepts the following options:
+\label{\detokenize{man/expire_backups:options}}
+The \sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} command accepts the following options:
\begin{quote}
\begin{optionlist}{3cm}
\item [-{-}quiet]
@@ -4064,30 +4348,30 @@ be really quiet
Activate debugging output from specified modules (use
commas to separate multiple modules). Debug messages
will be written to the target specified by the
-\sphinxcode{-{-}log} option.
+\sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}debug]
Activate debugging output from all S3QL modules. Debug
messages will be written to the target specified by
-the \sphinxcode{-{-}log} option.
+the \sphinxcode{\sphinxupquote{-{-}log}} option.
\item [-{-}version]
just print program version and exit
\item [-{-}state \textless{}file\textgreater{}]
File to save state information in (default:
-''.expire\_backups.dat'')
+“.expire\_backups.dat”)
\item [-n]
Dry run. Just show which backups would be deleted.
\item [-{-}reconstruct-state]
Try to reconstruct a missing state file from backup
dates.
\item [-{-}use-s3qlrm]
-Use \sphinxcode{s3qlrm} command to delete backups.
+Use \sphinxcode{\sphinxupquote{s3qlrm}} command to delete backups.
\end{optionlist}
\end{quote}
\subsection{Exit Codes}
-\label{man/expire_backups:exit-codes}
-\textbf{\texttt{expire\_backups}} may terminate with the following exit codes:
+\label{\detokenize{man/expire_backups:exit-codes}}
+\sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} may terminate with the following exit codes:
\begin{quote}\begin{description}
\item[{0}] \leavevmode
Everything went well.
@@ -4103,48 +4387,48 @@ Invalid command line argument or configuration file key.
\subsection{See Also}
-\label{man/expire_backups:see-also}
-\textbf{\texttt{expire\_backups}} is shipped as part of S3QL, \url{https://bitbucket.org/nikratio/s3ql/}.
+\label{\detokenize{man/expire_backups:see-also}}
+\sphinxstyleliteralstrong{\sphinxupquote{expire\_backups}} is shipped as part of S3QL, \sphinxurl{https://github.com/s3ql/s3ql/}.
\chapter{Further Resources / Getting Help}
-\label{resources::doc}\label{resources:further-resources-getting-help}\label{resources:resources}
-If you have questions or problems with S3QL that you weren't able to
+\label{\detokenize{resources:further-resources-getting-help}}\label{\detokenize{resources:resources}}\label{\detokenize{resources::doc}}
+If you have questions or problems with S3QL that you weren’t able to
resolve with this manual, you might want to consider the following other resources:
\begin{itemize}
\item {}
-The \href{https://bitbucket.org/nikratio/s3ql/wiki}{S3QL Wiki}
-
-\item {}
-The \href{https://bitbucket.org/nikratio/s3ql/wiki/FAQ}{S3QL FAQ}
+The \sphinxhref{https://github.com/s3ql/s3ql/wiki}{S3QL Wiki}
\item {}
-The \href{http://groups.google.com/group/s3ql}{S3QL Mailing List}. You
+The \sphinxhref{http://groups.google.com/group/s3ql}{S3QL Mailing List}. You
can subscribe by sending a mail to
-\href{mailto:s3ql+subscribe@googlegroups.com}{s3ql+subscribe@googlegroups.com}.
+\sphinxhref{mailto:s3ql+subscribe@googlegroups.com}{s3ql+subscribe@googlegroups.com}.
\end{itemize}
-Please report any bugs you may encounter in the \href{https://bitbucket.org/nikratio/s3ql/issues}{Issue Tracker}.
+Please report any bugs you may encounter in the \sphinxhref{https://github.com/s3ql/s3ql/issues}{Issue Tracker}.
\chapter{Implementation Details}
-\label{impl_details:implementation-details}\label{impl_details::doc}\label{impl_details:impl-details}
+\label{\detokenize{impl_details:implementation-details}}\label{\detokenize{impl_details:impl-details}}\label{\detokenize{impl_details::doc}}
This section provides some background information on how S3QL works
internally. Reading this section is not necessary to use S3QL.
\section{Metadata Storage}
-\label{impl_details:metadata-storage}
+\label{\detokenize{impl_details:metadata-storage}}
Like most unix filesystems, S3QL has a concept of inodes.
The contents of directory inodes (aka the names and inodes of the
files and sub directories contained in a directory) are stored
-directly in an \href{http://www.sqlite.org/}{SQLite} database. This database
+directly in an \sphinxhref{http://www.sqlite.org/}{SQLite} database. This database
is stored in a special storage object that is downloaded when the file
system is mounted and uploaded periodically in the background and when
the file system is unmounted. This has two implications:
\begin{enumerate}
+\def\theenumi{\arabic{enumi}}
+\def\labelenumi{\theenumi .}
+\makeatletter\def\p@enumii{\p@enumi \theenumi .}\makeatother
\item {}
The entire file system tree can be read from the
database. Fetching/storing storage objects from/in the storage
@@ -4154,7 +4438,7 @@ fast because no data has to be send over the network.
\item {}
An S3QL filesystem can only be mounted on one computer at a time,
-using a single \textbf{\texttt{mount.s3ql}} process. Otherwise changes made in
+using a single \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} process. Otherwise changes made in
one mountpoint will invariably be overwritten when the second mount
point is unmounted.
@@ -4165,7 +4449,7 @@ storage, all information about them is contained in the database.
\section{Data Storage}
-\label{impl_details:data-storage}
+\label{\detokenize{impl_details:data-storage}}
The contents of file inodes are split into individual blocks. The
maximum size of a block is specified when the file system is created
and cannot be changed afterwards. Every block is stored as an
@@ -4184,7 +4468,7 @@ once).
\section{Data De-Duplication}
-\label{impl_details:data-de-duplication}
+\label{\detokenize{impl_details:data-de-duplication}}
Instead of uploading every block, S3QL first computes a checksum (a
SHA256 hash) to check if an identical blocks has already been stored
in an backend object. If that is the case, the new block will be
@@ -4198,7 +4482,7 @@ unchanged).
\section{Caching}
-\label{impl_details:caching}
+\label{\detokenize{impl_details:caching}}
When an application tries to read or write from a file, S3QL
determines the block that contains the required part of the file and
retrieves it from the backend or creates it if it does not yet exist.
@@ -4211,13 +4495,13 @@ the backend and the cache is cleaned.
\section{Eventual Consistency Handling}
-\label{impl_details:eventual-consistency-handling}
+\label{\detokenize{impl_details:eventual-consistency-handling}}
S3QL has to take into account that with some storage providers,
changes in objects do not propagate immediately. For example, when an
Amazon S3 object is uploaded and immediately downloaded again, the
downloaded data might not yet reflect the changes done in the upload
(see also
-\url{http://developer.amazonwebservices.com/connect/message.jspa?messageID=38538})
+\sphinxurl{http://developer.amazonwebservices.com/connect/message.jspa?messageID=38538})
For the data blocks this is not a problem because a data blocks always
get a new object ID when they are updated.
@@ -4228,7 +4512,7 @@ system.
To that end, metadata versions are numbered, and the most recent
version number is stored as part of the object id of a very small
-``marker'' object. When S3QL has downloaded the metadata it checks the
+“marker” object. When S3QL has downloaded the metadata it checks the
version number against the marker object and, if the two do not agree,
waits for the most recent metadata to become available. Once the
current metadata is available, the version number is increased and the
@@ -4236,9 +4520,9 @@ marker object updated.
\section{Encryption}
-\label{impl_details:encryption}
-When the file system is created, \textbf{\texttt{mkfs.s3ql}} generates a 256 bit
-master key by reading from \sphinxcode{/dev/random}. The master key is
+\label{\detokenize{impl_details:encryption}}
+When the file system is created, \sphinxstyleliteralstrong{\sphinxupquote{mkfs.s3ql}} generates a 256 bit
+master key by reading from \sphinxcode{\sphinxupquote{/dev/random}}. The master key is
encrypted with the passphrase that is entered by the user, and then
stored with the rest of the file system data. Since the passphrase is
only used to access the master key (which is used to encrypt the
@@ -4248,16 +4532,16 @@ Data is encrypted with a new session key for each object and each
upload. The session key is generated by appending a nonce to the
master key and then calculating the SHA256 hash. The nonce is
generated by concatenating the object id and the current UTC time as a
-32 bit float. The precision of the time is given by the Python \href{http://docs.python.org/library/time.html\#time.time}{time()} function and
+32 bit float. The precision of the time is given by the Python \sphinxhref{http://docs.python.org/library/time.html\#time.time}{time()} function and
usually at least 1 millisecond. The SHA256 implementation is included
in the Python standard library.
Once the session key has been calculated, a SHA256 HMAC is calculated
over the data that is to be uploaded. Afterwards, the data is
-compressed (unless \sphinxcode{-{-}compress none} was passed to
-\textbf{\texttt{mount.s3ql}}) and the HMAC inserted at the beginning. Both HMAC
+compressed (unless \sphinxcode{\sphinxupquote{-{-}compress none}} was passed to
+\sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}}) and the HMAC inserted at the beginning. Both HMAC
and compressed data are then encrypted using 256 bit AES in CTR
-mode using \href{http://www.pycrypto.org/}{PyCrypto}. Finally, the nonce is
+mode using \sphinxhref{http://www.pycrypto.org/}{PyCrypto}. Finally, the nonce is
inserted in front of the encrypted data and HMAC, and the packet is
send to the backend as a new S3 object.
@@ -4265,4 +4549,4 @@ send to the backend as a new S3 object.
\renewcommand{\indexname}{Index}
\printindex
-\end{document}
+\end{document} \ No newline at end of file
diff --git a/doc/latex/manual.toc b/doc/latex/manual.toc
index 8792d8b..e31265b 100644
--- a/doc/latex/manual.toc
+++ b/doc/latex/manual.toc
@@ -6,7 +6,7 @@
\contentsline {section}{\numberline {1.4}Contributing}{2}{section.1.4}
\contentsline {chapter}{\numberline {2}Installation}{3}{chapter.2}
\contentsline {section}{\numberline {2.1}Dependencies}{3}{section.2.1}
-\contentsline {section}{\numberline {2.2}Installing S3QL}{4}{section.2.2}
+\contentsline {section}{\numberline {2.2}Installing S3QL}{3}{section.2.2}
\contentsline {section}{\numberline {2.3}Development Version}{4}{section.2.3}
\contentsline {section}{\numberline {2.4}Running tests requiring remote servers}{4}{section.2.4}
\contentsline {chapter}{\numberline {3}Storage Backends}{7}{chapter.3}
@@ -59,100 +59,115 @@
\contentsline {section}{\numberline {13.1}SSH Backend}{41}{section.13.1}
\contentsline {section}{\numberline {13.2}Permanently mounted backup file system}{41}{section.13.2}
\contentsline {section}{\numberline {13.3}Improving copy performance}{41}{section.13.3}
-\contentsline {chapter}{\numberline {14}Known Issues}{43}{chapter.14}
-\contentsline {chapter}{\numberline {15}Manpages}{45}{chapter.15}
-\contentsline {section}{\numberline {15.1}The \textbf {\texttt {mkfs.s3ql}} command}{45}{section.15.1}
-\contentsline {subsection}{\numberline {15.1.1}Synopsis}{45}{subsection.15.1.1}
-\contentsline {subsection}{\numberline {15.1.2}Description}{45}{subsection.15.1.2}
-\contentsline {subsection}{\numberline {15.1.3}Options}{45}{subsection.15.1.3}
-\contentsline {subsection}{\numberline {15.1.4}Exit Codes}{46}{subsection.15.1.4}
-\contentsline {subsection}{\numberline {15.1.5}See Also}{46}{subsection.15.1.5}
-\contentsline {section}{\numberline {15.2}The \textbf {\texttt {s3qladm}} command}{46}{section.15.2}
-\contentsline {subsection}{\numberline {15.2.1}Synopsis}{46}{subsection.15.2.1}
-\contentsline {subsection}{\numberline {15.2.2}Description}{47}{subsection.15.2.2}
-\contentsline {subsection}{\numberline {15.2.3}Options}{47}{subsection.15.2.3}
-\contentsline {subsection}{\numberline {15.2.4}Actions}{47}{subsection.15.2.4}
-\contentsline {subsection}{\numberline {15.2.5}Exit Codes}{47}{subsection.15.2.5}
-\contentsline {subsection}{\numberline {15.2.6}See Also}{48}{subsection.15.2.6}
-\contentsline {section}{\numberline {15.3}The \textbf {\texttt {mount.s3ql}} command}{48}{section.15.3}
-\contentsline {subsection}{\numberline {15.3.1}Synopsis}{48}{subsection.15.3.1}
-\contentsline {subsection}{\numberline {15.3.2}Description}{48}{subsection.15.3.2}
-\contentsline {subsection}{\numberline {15.3.3}Options}{48}{subsection.15.3.3}
-\contentsline {subsection}{\numberline {15.3.4}Exit Codes}{49}{subsection.15.3.4}
-\contentsline {subsection}{\numberline {15.3.5}See Also}{50}{subsection.15.3.5}
-\contentsline {section}{\numberline {15.4}The \textbf {\texttt {s3qlstat}} command}{50}{section.15.4}
-\contentsline {subsection}{\numberline {15.4.1}Synopsis}{50}{subsection.15.4.1}
-\contentsline {subsection}{\numberline {15.4.2}Description}{50}{subsection.15.4.2}
-\contentsline {subsection}{\numberline {15.4.3}Options}{51}{subsection.15.4.3}
-\contentsline {subsection}{\numberline {15.4.4}Exit Codes}{51}{subsection.15.4.4}
-\contentsline {subsection}{\numberline {15.4.5}See Also}{51}{subsection.15.4.5}
-\contentsline {section}{\numberline {15.5}The \textbf {\texttt {s3qlctrl}} command}{51}{section.15.5}
-\contentsline {subsection}{\numberline {15.5.1}Synopsis}{51}{subsection.15.5.1}
-\contentsline {subsection}{\numberline {15.5.2}Description}{51}{subsection.15.5.2}
-\contentsline {subsection}{\numberline {15.5.3}Options}{52}{subsection.15.5.3}
-\contentsline {subsection}{\numberline {15.5.4}Exit Codes}{52}{subsection.15.5.4}
-\contentsline {subsection}{\numberline {15.5.5}See Also}{52}{subsection.15.5.5}
-\contentsline {section}{\numberline {15.6}The \textbf {\texttt {s3qlcp}} command}{52}{section.15.6}
-\contentsline {subsection}{\numberline {15.6.1}Synopsis}{52}{subsection.15.6.1}
-\contentsline {subsection}{\numberline {15.6.2}Description}{53}{subsection.15.6.2}
-\contentsline {subsubsection}{Snapshotting vs Hardlinking}{53}{subsubsection*.22}
-\contentsline {subsection}{\numberline {15.6.3}Options}{53}{subsection.15.6.3}
-\contentsline {subsection}{\numberline {15.6.4}Exit Codes}{53}{subsection.15.6.4}
-\contentsline {subsection}{\numberline {15.6.5}See Also}{54}{subsection.15.6.5}
-\contentsline {section}{\numberline {15.7}The \textbf {\texttt {s3qlrm}} command}{54}{section.15.7}
-\contentsline {subsection}{\numberline {15.7.1}Synopsis}{54}{subsection.15.7.1}
-\contentsline {subsection}{\numberline {15.7.2}Description}{54}{subsection.15.7.2}
-\contentsline {subsection}{\numberline {15.7.3}Options}{54}{subsection.15.7.3}
-\contentsline {subsection}{\numberline {15.7.4}Exit Codes}{54}{subsection.15.7.4}
-\contentsline {subsection}{\numberline {15.7.5}See Also}{55}{subsection.15.7.5}
-\contentsline {section}{\numberline {15.8}The \textbf {\texttt {s3qllock}} command}{55}{section.15.8}
-\contentsline {subsection}{\numberline {15.8.1}Synopsis}{55}{subsection.15.8.1}
-\contentsline {subsection}{\numberline {15.8.2}Description}{55}{subsection.15.8.2}
-\contentsline {subsection}{\numberline {15.8.3}Rationale}{55}{subsection.15.8.3}
-\contentsline {subsection}{\numberline {15.8.4}Options}{55}{subsection.15.8.4}
-\contentsline {subsection}{\numberline {15.8.5}Exit Codes}{56}{subsection.15.8.5}
-\contentsline {subsection}{\numberline {15.8.6}See Also}{56}{subsection.15.8.6}
-\contentsline {section}{\numberline {15.9}The \textbf {\texttt {umount.s3ql}} command}{56}{section.15.9}
-\contentsline {subsection}{\numberline {15.9.1}Synopsis}{56}{subsection.15.9.1}
-\contentsline {subsection}{\numberline {15.9.2}Description}{56}{subsection.15.9.2}
-\contentsline {subsection}{\numberline {15.9.3}Options}{56}{subsection.15.9.3}
-\contentsline {subsection}{\numberline {15.9.4}Exit Codes}{57}{subsection.15.9.4}
-\contentsline {subsection}{\numberline {15.9.5}See Also}{57}{subsection.15.9.5}
-\contentsline {section}{\numberline {15.10}The \textbf {\texttt {fsck.s3ql}} command}{57}{section.15.10}
-\contentsline {subsection}{\numberline {15.10.1}Synopsis}{57}{subsection.15.10.1}
-\contentsline {subsection}{\numberline {15.10.2}Description}{57}{subsection.15.10.2}
-\contentsline {subsection}{\numberline {15.10.3}Options}{57}{subsection.15.10.3}
-\contentsline {subsection}{\numberline {15.10.4}Exit Codes}{58}{subsection.15.10.4}
-\contentsline {subsection}{\numberline {15.10.5}See Also}{59}{subsection.15.10.5}
-\contentsline {section}{\numberline {15.11}The \textbf {\texttt {s3ql\_oauth\_client}} command}{59}{section.15.11}
-\contentsline {subsection}{\numberline {15.11.1}Synopsis}{59}{subsection.15.11.1}
-\contentsline {subsection}{\numberline {15.11.2}Description}{59}{subsection.15.11.2}
-\contentsline {subsection}{\numberline {15.11.3}Options}{59}{subsection.15.11.3}
-\contentsline {subsection}{\numberline {15.11.4}Exit Codes}{59}{subsection.15.11.4}
-\contentsline {subsection}{\numberline {15.11.5}See Also}{60}{subsection.15.11.5}
-\contentsline {section}{\numberline {15.12}The \textbf {\texttt {s3ql\_verify}} command}{60}{section.15.12}
-\contentsline {subsection}{\numberline {15.12.1}Synopsis}{60}{subsection.15.12.1}
-\contentsline {subsection}{\numberline {15.12.2}Description}{60}{subsection.15.12.2}
-\contentsline {subsection}{\numberline {15.12.3}Options}{60}{subsection.15.12.3}
-\contentsline {subsection}{\numberline {15.12.4}Exit Codes}{61}{subsection.15.12.4}
-\contentsline {subsection}{\numberline {15.12.5}See Also}{61}{subsection.15.12.5}
-\contentsline {section}{\numberline {15.13}The \textbf {\texttt {pcp}} command}{61}{section.15.13}
-\contentsline {subsection}{\numberline {15.13.1}Synopsis}{61}{subsection.15.13.1}
-\contentsline {subsection}{\numberline {15.13.2}Description}{61}{subsection.15.13.2}
-\contentsline {subsection}{\numberline {15.13.3}Options}{62}{subsection.15.13.3}
-\contentsline {subsection}{\numberline {15.13.4}Exit Codes}{62}{subsection.15.13.4}
-\contentsline {subsection}{\numberline {15.13.5}See Also}{62}{subsection.15.13.5}
-\contentsline {section}{\numberline {15.14}The \textbf {\texttt {expire\_backups}} command}{62}{section.15.14}
-\contentsline {subsection}{\numberline {15.14.1}Synopsis}{62}{subsection.15.14.1}
-\contentsline {subsection}{\numberline {15.14.2}Description}{62}{subsection.15.14.2}
-\contentsline {subsection}{\numberline {15.14.3}Options}{63}{subsection.15.14.3}
-\contentsline {subsection}{\numberline {15.14.4}Exit Codes}{64}{subsection.15.14.4}
-\contentsline {subsection}{\numberline {15.14.5}See Also}{64}{subsection.15.14.5}
-\contentsline {chapter}{\numberline {16}Further Resources / Getting Help}{65}{chapter.16}
-\contentsline {chapter}{\numberline {17}Implementation Details}{67}{chapter.17}
-\contentsline {section}{\numberline {17.1}Metadata Storage}{67}{section.17.1}
-\contentsline {section}{\numberline {17.2}Data Storage}{67}{section.17.2}
-\contentsline {section}{\numberline {17.3}Data De-Duplication}{68}{section.17.3}
-\contentsline {section}{\numberline {17.4}Caching}{68}{section.17.4}
-\contentsline {section}{\numberline {17.5}Eventual Consistency Handling}{68}{section.17.5}
-\contentsline {section}{\numberline {17.6}Encryption}{68}{section.17.6}
+\contentsline {chapter}{\numberline {14}Frequently Asked Questions}{43}{chapter.14}
+\contentsline {section}{\numberline {14.1}What does \IeC {\textquotedblleft }python-apsw must be linked dynamically to sqlite3\IeC {\textquotedblright } mean?}{43}{section.14.1}
+\contentsline {section}{\numberline {14.2}How can I improve the file system throughput?}{43}{section.14.2}
+\contentsline {section}{\numberline {14.3}Why does \sphinxstyleliteralintitle {\sphinxupquote {df}} show 1 TB of free space?}{43}{section.14.3}
+\contentsline {section}{\numberline {14.4}Which operating systems are supported?}{44}{section.14.4}
+\contentsline {section}{\numberline {14.5}Is there a file size limit?}{44}{section.14.5}
+\contentsline {section}{\numberline {14.6}Suppose I want to make a small change in a very large file. Will S3QL download and re-upload the entire file?}{44}{section.14.6}
+\contentsline {section}{\numberline {14.7}I don\IeC {\textquoteright }t quite understand this de-duplication feature\IeC {\textellipsis }}{44}{section.14.7}
+\contentsline {section}{\numberline {14.8}What does the \IeC {\textquotedblleft }Transport endpoint not connected\IeC {\textquotedblright } error mean?}{44}{section.14.8}
+\contentsline {section}{\numberline {14.9}What does \IeC {\textquotedblleft }Backend reports that fs is still mounted elsewhere, aborting\IeC {\textquotedblright } mean?}{44}{section.14.9}
+\contentsline {section}{\numberline {14.10}Can I access an S3QL file system on multiple computers simultaneously?}{45}{section.14.10}
+\contentsline {section}{\numberline {14.11}What maximum object size should I use?}{45}{section.14.11}
+\contentsline {section}{\numberline {14.12}Is there a way to make the cache persistent / access the file system offline?}{46}{section.14.12}
+\contentsline {section}{\numberline {14.13}I would like to use S3QL with Hubic, but\IeC {\textellipsis }}{46}{section.14.13}
+\contentsline {section}{\numberline {14.14}What\IeC {\textquoteright }s a reasonable metadata upload interval?}{46}{section.14.14}
+\contentsline {chapter}{\numberline {15}Known Issues}{49}{chapter.15}
+\contentsline {chapter}{\numberline {16}Manpages}{51}{chapter.16}
+\contentsline {section}{\numberline {16.1}The \sphinxstyleliteralstrong {\sphinxupquote {mkfs.s3ql}} command}{51}{section.16.1}
+\contentsline {subsection}{\numberline {16.1.1}Synopsis}{51}{subsection.16.1.1}
+\contentsline {subsection}{\numberline {16.1.2}Description}{51}{subsection.16.1.2}
+\contentsline {subsection}{\numberline {16.1.3}Options}{51}{subsection.16.1.3}
+\contentsline {subsection}{\numberline {16.1.4}Exit Codes}{52}{subsection.16.1.4}
+\contentsline {subsection}{\numberline {16.1.5}See Also}{52}{subsection.16.1.5}
+\contentsline {section}{\numberline {16.2}The \sphinxstyleliteralstrong {\sphinxupquote {s3qladm}} command}{52}{section.16.2}
+\contentsline {subsection}{\numberline {16.2.1}Synopsis}{52}{subsection.16.2.1}
+\contentsline {subsection}{\numberline {16.2.2}Description}{53}{subsection.16.2.2}
+\contentsline {subsection}{\numberline {16.2.3}Options}{53}{subsection.16.2.3}
+\contentsline {subsection}{\numberline {16.2.4}Actions}{53}{subsection.16.2.4}
+\contentsline {subsection}{\numberline {16.2.5}Exit Codes}{53}{subsection.16.2.5}
+\contentsline {subsection}{\numberline {16.2.6}See Also}{54}{subsection.16.2.6}
+\contentsline {section}{\numberline {16.3}The \sphinxstyleliteralstrong {\sphinxupquote {mount.s3ql}} command}{54}{section.16.3}
+\contentsline {subsection}{\numberline {16.3.1}Synopsis}{54}{subsection.16.3.1}
+\contentsline {subsection}{\numberline {16.3.2}Description}{54}{subsection.16.3.2}
+\contentsline {subsection}{\numberline {16.3.3}Options}{54}{subsection.16.3.3}
+\contentsline {subsection}{\numberline {16.3.4}Exit Codes}{55}{subsection.16.3.4}
+\contentsline {subsection}{\numberline {16.3.5}See Also}{56}{subsection.16.3.5}
+\contentsline {section}{\numberline {16.4}The \sphinxstyleliteralstrong {\sphinxupquote {s3qlstat}} command}{56}{section.16.4}
+\contentsline {subsection}{\numberline {16.4.1}Synopsis}{56}{subsection.16.4.1}
+\contentsline {subsection}{\numberline {16.4.2}Description}{56}{subsection.16.4.2}
+\contentsline {subsection}{\numberline {16.4.3}Options}{57}{subsection.16.4.3}
+\contentsline {subsection}{\numberline {16.4.4}Exit Codes}{57}{subsection.16.4.4}
+\contentsline {subsection}{\numberline {16.4.5}See Also}{57}{subsection.16.4.5}
+\contentsline {section}{\numberline {16.5}The \sphinxstyleliteralstrong {\sphinxupquote {s3qlctrl}} command}{57}{section.16.5}
+\contentsline {subsection}{\numberline {16.5.1}Synopsis}{57}{subsection.16.5.1}
+\contentsline {subsection}{\numberline {16.5.2}Description}{57}{subsection.16.5.2}
+\contentsline {subsection}{\numberline {16.5.3}Options}{58}{subsection.16.5.3}
+\contentsline {subsection}{\numberline {16.5.4}Exit Codes}{58}{subsection.16.5.4}
+\contentsline {subsection}{\numberline {16.5.5}See Also}{58}{subsection.16.5.5}
+\contentsline {section}{\numberline {16.6}The \sphinxstyleliteralstrong {\sphinxupquote {s3qlcp}} command}{58}{section.16.6}
+\contentsline {subsection}{\numberline {16.6.1}Synopsis}{58}{subsection.16.6.1}
+\contentsline {subsection}{\numberline {16.6.2}Description}{59}{subsection.16.6.2}
+\contentsline {subsubsection}{Snapshotting vs Hardlinking}{59}{subsubsection*.22}
+\contentsline {subsection}{\numberline {16.6.3}Options}{59}{subsection.16.6.3}
+\contentsline {subsection}{\numberline {16.6.4}Exit Codes}{59}{subsection.16.6.4}
+\contentsline {subsection}{\numberline {16.6.5}See Also}{60}{subsection.16.6.5}
+\contentsline {section}{\numberline {16.7}The \sphinxstyleliteralstrong {\sphinxupquote {s3qlrm}} command}{60}{section.16.7}
+\contentsline {subsection}{\numberline {16.7.1}Synopsis}{60}{subsection.16.7.1}
+\contentsline {subsection}{\numberline {16.7.2}Description}{60}{subsection.16.7.2}
+\contentsline {subsection}{\numberline {16.7.3}Options}{60}{subsection.16.7.3}
+\contentsline {subsection}{\numberline {16.7.4}Exit Codes}{60}{subsection.16.7.4}
+\contentsline {subsection}{\numberline {16.7.5}See Also}{61}{subsection.16.7.5}
+\contentsline {section}{\numberline {16.8}The \sphinxstyleliteralstrong {\sphinxupquote {s3qllock}} command}{61}{section.16.8}
+\contentsline {subsection}{\numberline {16.8.1}Synopsis}{61}{subsection.16.8.1}
+\contentsline {subsection}{\numberline {16.8.2}Description}{61}{subsection.16.8.2}
+\contentsline {subsection}{\numberline {16.8.3}Rationale}{61}{subsection.16.8.3}
+\contentsline {subsection}{\numberline {16.8.4}Options}{61}{subsection.16.8.4}
+\contentsline {subsection}{\numberline {16.8.5}Exit Codes}{62}{subsection.16.8.5}
+\contentsline {subsection}{\numberline {16.8.6}See Also}{62}{subsection.16.8.6}
+\contentsline {section}{\numberline {16.9}The \sphinxstyleliteralstrong {\sphinxupquote {umount.s3ql}} command}{62}{section.16.9}
+\contentsline {subsection}{\numberline {16.9.1}Synopsis}{62}{subsection.16.9.1}
+\contentsline {subsection}{\numberline {16.9.2}Description}{62}{subsection.16.9.2}
+\contentsline {subsection}{\numberline {16.9.3}Options}{62}{subsection.16.9.3}
+\contentsline {subsection}{\numberline {16.9.4}Exit Codes}{63}{subsection.16.9.4}
+\contentsline {subsection}{\numberline {16.9.5}See Also}{63}{subsection.16.9.5}
+\contentsline {section}{\numberline {16.10}The \sphinxstyleliteralstrong {\sphinxupquote {fsck.s3ql}} command}{63}{section.16.10}
+\contentsline {subsection}{\numberline {16.10.1}Synopsis}{63}{subsection.16.10.1}
+\contentsline {subsection}{\numberline {16.10.2}Description}{63}{subsection.16.10.2}
+\contentsline {subsection}{\numberline {16.10.3}Options}{63}{subsection.16.10.3}
+\contentsline {subsection}{\numberline {16.10.4}Exit Codes}{64}{subsection.16.10.4}
+\contentsline {subsection}{\numberline {16.10.5}See Also}{65}{subsection.16.10.5}
+\contentsline {section}{\numberline {16.11}The \sphinxstyleliteralstrong {\sphinxupquote {s3ql\_oauth\_client}} command}{65}{section.16.11}
+\contentsline {subsection}{\numberline {16.11.1}Synopsis}{65}{subsection.16.11.1}
+\contentsline {subsection}{\numberline {16.11.2}Description}{65}{subsection.16.11.2}
+\contentsline {subsection}{\numberline {16.11.3}Options}{65}{subsection.16.11.3}
+\contentsline {subsection}{\numberline {16.11.4}Exit Codes}{65}{subsection.16.11.4}
+\contentsline {subsection}{\numberline {16.11.5}See Also}{66}{subsection.16.11.5}
+\contentsline {section}{\numberline {16.12}The \sphinxstyleliteralstrong {\sphinxupquote {s3ql\_verify}} command}{66}{section.16.12}
+\contentsline {subsection}{\numberline {16.12.1}Synopsis}{66}{subsection.16.12.1}
+\contentsline {subsection}{\numberline {16.12.2}Description}{66}{subsection.16.12.2}
+\contentsline {subsection}{\numberline {16.12.3}Options}{66}{subsection.16.12.3}
+\contentsline {subsection}{\numberline {16.12.4}Exit Codes}{67}{subsection.16.12.4}
+\contentsline {subsection}{\numberline {16.12.5}See Also}{67}{subsection.16.12.5}
+\contentsline {section}{\numberline {16.13}The \sphinxstyleliteralstrong {\sphinxupquote {pcp}} command}{67}{section.16.13}
+\contentsline {subsection}{\numberline {16.13.1}Synopsis}{67}{subsection.16.13.1}
+\contentsline {subsection}{\numberline {16.13.2}Description}{67}{subsection.16.13.2}
+\contentsline {subsection}{\numberline {16.13.3}Options}{68}{subsection.16.13.3}
+\contentsline {subsection}{\numberline {16.13.4}Exit Codes}{68}{subsection.16.13.4}
+\contentsline {subsection}{\numberline {16.13.5}See Also}{68}{subsection.16.13.5}
+\contentsline {section}{\numberline {16.14}The \sphinxstyleliteralstrong {\sphinxupquote {expire\_backups}} command}{68}{section.16.14}
+\contentsline {subsection}{\numberline {16.14.1}Synopsis}{68}{subsection.16.14.1}
+\contentsline {subsection}{\numberline {16.14.2}Description}{68}{subsection.16.14.2}
+\contentsline {subsection}{\numberline {16.14.3}Options}{69}{subsection.16.14.3}
+\contentsline {subsection}{\numberline {16.14.4}Exit Codes}{70}{subsection.16.14.4}
+\contentsline {subsection}{\numberline {16.14.5}See Also}{70}{subsection.16.14.5}
+\contentsline {chapter}{\numberline {17}Further Resources / Getting Help}{71}{chapter.17}
+\contentsline {chapter}{\numberline {18}Implementation Details}{73}{chapter.18}
+\contentsline {section}{\numberline {18.1}Metadata Storage}{73}{section.18.1}
+\contentsline {section}{\numberline {18.2}Data Storage}{73}{section.18.2}
+\contentsline {section}{\numberline {18.3}Data De-Duplication}{74}{section.18.3}
+\contentsline {section}{\numberline {18.4}Caching}{74}{section.18.4}
+\contentsline {section}{\numberline {18.5}Eventual Consistency Handling}{74}{section.18.5}
+\contentsline {section}{\numberline {18.6}Encryption}{74}{section.18.6}
diff --git a/doc/latex/python.ist b/doc/latex/python.ist
index 9ffa0f9..7a1c06f 100644
--- a/doc/latex/python.ist
+++ b/doc/latex/python.ist
@@ -2,10 +2,12 @@ line_max 100
headings_flag 1
heading_prefix " \\bigletter "
-preamble "\\begin{theindex}
-\\def\\bigletter#1{{\\Large\\sffamily#1}\\nopagebreak\\vspace{1mm}}
+preamble "\\begin{sphinxtheindex}
+\\let\\bigletter\\sphinxstyleindexlettergroup
"
-symhead_positive "{Symbols}"
-numhead_positive "{Numbers}"
+postamble "\n\n\\end{sphinxtheindex}\n"
+
+symhead_positive "{\\sphinxsymbolsname}"
+numhead_positive "{\\sphinxnumbersname}"
diff --git a/doc/latex/sphinx.sty b/doc/latex/sphinx.sty
index d025a07..fc75bf3 100644
--- a/doc/latex/sphinx.sty
+++ b/doc/latex/sphinx.sty
@@ -6,38 +6,156 @@
%
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
-\ProvidesPackage{sphinx}[2010/01/15 LaTeX package (Sphinx markup)]
-
-% this is the \ltx@ifundefined of ltxcmds.sty, which is loaded by
-% hyperref.sty, but we need it before, and initial ltxcmds.sty
-% as in TL2009/Debian had wrong definition.
-\newcommand{\spx@ifundefined}[1]{%
- \ifcsname #1\endcsname
- \expandafter\ifx\csname #1\endcsname\relax
- \expandafter\expandafter\expandafter\@firstoftwo
- \else
- \expandafter\expandafter\expandafter\@secondoftwo
- \fi
- \else
- \expandafter\@firstoftwo
- \fi
-}
-
+\ProvidesPackage{sphinx}[2018/07/18 v1.8 LaTeX package (Sphinx markup)]
+
+% provides \ltx@ifundefined
+% (many packages load ltxcmds: graphicx does for pdftex and lualatex but
+% not xelatex, and anyhow kvoptions does, but it may be needed in future to
+% use \sphinxdeprecationwarning earlier, and it needs \ltx@ifundefined)
+\RequirePackage{ltxcmds}
+
+%% for deprecation warnings
+\newcommand\sphinxdeprecationwarning[4]{% #1 the deprecated macro or name,
+% #2 = when deprecated, #3 = when removed, #4 = additional info
+ \edef\spx@tempa{\detokenize{#1}}%
+ \ltx@ifundefined{sphinx_depr_\spx@tempa}{%
+ \global\expandafter\let\csname sphinx_depr_\spx@tempa\endcsname\spx@tempa
+ \expandafter\AtEndDocument\expandafter{\expandafter\let\expandafter
+ \sphinxdeprecatedmacro\csname sphinx_depr_\spx@tempa\endcsname
+ \PackageWarningNoLine{sphinx}{^^J**** SPHINX DEPRECATION WARNING:^^J
+ \sphinxdeprecatedmacro^^J
+ \@spaces- is deprecated at Sphinx #2^^J
+ \@spaces- and removed at Sphinx #3.^^J
+ #4^^J****}}%
+ }{% warning already emitted (at end of latex log), don't repeat
+ }}
+
+
+%% PACKAGES
+%
+% we delay handling of options to after having loaded packages, because
+% of the need to use \definecolor.
+\RequirePackage{graphicx}
\@ifclassloaded{memoir}{}{\RequirePackage{fancyhdr}}
-
% for \text macro and \iffirstchoice@ conditional even if amsmath not loaded
\RequirePackage{amstext}
-\RequirePackage{textcomp}
-% fancybox not used anymore and will be removed at Sphinx-1.5
-\RequirePackage{fancybox}
+\RequirePackage{textcomp}% "warn" option issued from template
\RequirePackage{titlesec}
+\@ifpackagelater{titlesec}{2016/03/15}%
+ {\@ifpackagelater{titlesec}{2016/03/21}%
+ {}%
+ {\newif\ifsphinx@ttlpatch@ok
+ \IfFileExists{etoolbox.sty}{%
+ \RequirePackage{etoolbox}%
+ \patchcmd{\ttlh@hang}{\parindent\z@}{\parindent\z@\leavevmode}%
+ {\sphinx@ttlpatch@oktrue}{}%
+ \ifsphinx@ttlpatch@ok
+ \patchcmd{\ttlh@hang}{\noindent}{}{}{\sphinx@ttlpatch@okfalse}%
+ \fi
+ }{}%
+ \ifsphinx@ttlpatch@ok
+ \typeout{^^J Package Sphinx Info: ^^J
+ **** titlesec 2.10.1 successfully patched for bugfix ****^^J}%
+ \else
+ \AtEndDocument{\PackageWarningNoLine{sphinx}{^^J%
+******** titlesec 2.10.1 has a bug, (section numbers disappear) ......|^^J%
+******** and Sphinx could not patch it, perhaps because your local ...|^^J%
+******** copy is already fixed without a changed release date. .......|^^J%
+******** If not, you must update titlesec! ...........................|}}%
+ \fi
+ }%
+ }{}
\RequirePackage{tabulary}
+% tabulary has a bug with its re-definition of \multicolumn in its first pass
+% which is not \long. But now Sphinx does not use LaTeX's \multicolumn but its
+% own macro. Hence we don't even need to patch tabulary. See sphinxmulticell.sty
+% X or S (Sphinx) may have meanings if some table package is loaded hence
+% \X was chosen to avoid possibility of conflict
+\newcolumntype{\X}[2]{p{\dimexpr
+ (\linewidth-\arrayrulewidth)*#1/#2-\tw@\tabcolsep-\arrayrulewidth\relax}}
+\newcolumntype{\Y}[1]{p{\dimexpr
+ #1\dimexpr\linewidth-\arrayrulewidth\relax-\tw@\tabcolsep-\arrayrulewidth\relax}}
+% using here T (for Tabulary) feels less of a problem than the X could be
+\newcolumntype{T}{J}%
+% For tables allowing pagebreaks
+\RequirePackage{longtable}
+% User interface to set-up whitespace before and after tables:
+\newcommand*\sphinxtablepre {0pt}%
+\newcommand*\sphinxtablepost{\medskipamount}%
+\newcommand*\sphinxbelowcaptionspace{.5\sphinxbaselineskip}%
+% as one can not use \baselineskip from inside longtable (it is zero there)
+% we need \sphinxbaselineskip, which defaults to \baselineskip
+\def\sphinxbaselineskip{\baselineskip}%
+% These commands are inserted by the table templates
+\def\sphinxatlongtablestart
+ {\par
+ \vskip\parskip
+ \vskip\dimexpr\sphinxtablepre\relax % adjust vertical position
+ \vbox{}% get correct baseline from above
+ \LTpre\z@skip\LTpost\z@skip % set to zero longtable's own skips
+ \edef\sphinxbaselineskip{\dimexpr\the\dimexpr\baselineskip\relax\relax}%
+ }%
+\def\sphinxatlongtableend{\prevdepth\z@\vskip\sphinxtablepost\relax}%
+\def\sphinxlongtablecapskipadjust
+ {\dimexpr-\dp\strutbox-\sphinxbaselineskip+\sphinxbelowcaptionspace\relax}%
+% Now for tables not using longtable
+\def\sphinxattablestart
+ {\par
+ \vskip\dimexpr\sphinxtablepre\relax
+ }%
+\let\sphinxattableend\sphinxatlongtableend
+% longtable's wraps captions to a maximal width of \LTcapwidth
+% so we do the same for all tables
+\newcommand*\sphinxcapstartof[1]{%
+ \vskip\parskip
+ \vbox{}% force baselineskip for good positioning by capstart of hyperanchor
+ \def\@captype{#1}%
+ \capstart
+% move back vertically to compensate space inserted by next paragraph
+ \vskip-\baselineskip\vskip-\parskip
+}%
+% use \LTcapwidth (default is 4in) to wrap caption (if line width is bigger)
+\newcommand\sphinxcaption[2][\LTcapwidth]{%
+ \noindent\hb@xt@\linewidth{\hss
+ \vtop{\@tempdima\dimexpr#1\relax
+% don't exceed linewidth for the caption width
+ \ifdim\@tempdima>\linewidth\hsize\linewidth\else\hsize\@tempdima\fi
+% longtable ignores \abovecaptionskip/\belowcaptionskip, so add hooks here
+% to uniformize control of caption distance to tables
+ \abovecaptionskip\sphinxabovecaptionskip
+ \belowcaptionskip\sphinxbelowcaptionskip
+ \caption[{#2}]%
+ {\strut\ignorespaces#2\ifhmode\unskip\@finalstrut\strutbox\fi}%
+ }\hss}%
+ \par\prevdepth\dp\strutbox
+}%
+\def\spx@abovecaptionskip{\abovecaptionskip}
+\newcommand*\sphinxabovecaptionskip{\z@skip}
+\newcommand*\sphinxbelowcaptionskip{\z@skip}
+
+\newcommand\sphinxaftercaption
+{% this default definition serves with a caption *above* a table, to make sure
+ % its last baseline is \sphinxbelowcaptionspace above table top
+ \nobreak
+ \vskip\dimexpr\sphinxbelowcaptionspace\relax
+ \vskip-\baselineskip\vskip-\parskip
+}%
+% varwidth is crucial for our handling of general contents in merged cells
+\RequirePackage{varwidth}
+% but addition of a compatibility patch with hyperref is needed
+% (tested with varwidth v 0.92 Mar 2009)
+\AtBeginDocument {%
+ \let\@@vwid@Hy@raisedlink\Hy@raisedlink
+ \long\def\@vwid@Hy@raisedlink#1{\@vwid@wrap{\@@vwid@Hy@raisedlink{#1}}}%
+ \edef\@vwid@setup{%
+ \let\noexpand\Hy@raisedlink\noexpand\@vwid@Hy@raisedlink % HYPERREF !
+ \unexpanded\expandafter{\@vwid@setup}}%
+}%
+% Homemade package to handle merged cells
+\RequirePackage{sphinxmulticell}
\RequirePackage{makeidx}
% For framing code-blocks and warning type notices, and shadowing topics
\RequirePackage{framed}
-\newif\ifspx@inframed % flag set if we are in a framed environment
-% ifthen not used anymore and will be removed at Sphinx-1.5
-\RequirePackage{ifthen}
% The xcolor package draws better fcolorboxes around verbatim code
\IfFileExists{xcolor.sty}{
\RequirePackage{xcolor}
@@ -46,12 +164,14 @@
}
% For highlighted code.
\RequirePackage{fancyvrb}
-% For table captions.
-\RequirePackage{threeparttable}
-% Handle footnotes in tables.
-\RequirePackage{footnote}
-\makesavenoteenv{tabulary}
-% For floating figures in the text.
+\define@key{FV}{hllines}{\def\sphinx@verbatim@checkifhl##1{\in@{, ##1,}{#1}}}
+% For hyperlinked footnotes in tables; also for gathering footnotes from
+% topic and warning blocks. Also to allow code-blocks in footnotes.
+\RequirePackage{footnotehyper-sphinx}
+% For the H specifier. Do not \restylefloat{figure}, it breaks Sphinx code
+% for allowing figures in tables.
+\RequirePackage{float}
+% For floating figures in the text. Better to load after float.
\RequirePackage{wrapfig}
% Separate paragraphs by space by default.
\RequirePackage{parskip}
@@ -59,72 +179,321 @@
\RequirePackage{alltt}
% Display "real" single quotes in literal blocks.
\RequirePackage{upquote}
-% For the H specifier. Do not \restylefloat{figure}, it breaks Sphinx code
-% for allowing figures in tables.
-\RequirePackage{float}
+% control caption around literal-block
+\RequirePackage{capt-of}
+\RequirePackage{needspace}
+% LaTeX 2018-04-01 and later provides \@removefromreset
+\ltx@ifundefined{@removefromreset}
+ {\RequirePackage{remreset}}
+ {}% avoid warning
+% to make pdf with correct encoded bookmarks in Japanese
+% this should precede the hyperref package
+\ifx\kanjiskip\@undefined
+% for non-Japanese: make sure bookmarks are ok also with lualatex
+ \PassOptionsToPackage{pdfencoding=unicode}{hyperref}
+\else
+ \RequirePackage{atbegshi}
+ \ifx\ucs\@undefined
+ \ifnum 42146=\euc"A4A2
+ \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}}
+ \else
+ \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}}
+ \fi
+ \else
+ \AtBeginShipoutFirst{\special{pdf:tounicode UTF8-UCS2}}
+ \fi
+\fi
-% Redefine these colors to your liking in the preamble.
-\definecolor{TitleColor}{rgb}{0.126,0.263,0.361}
-\definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486}
-\definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388}
-% Redefine these colors to something if you want to have colored
-% background and border for code examples.
-\definecolor{VerbatimColor}{rgb}{1,1,1}
-\definecolor{VerbatimBorderColor}{rgb}{0,0,0}
-
-% Uncomment these two lines to ignore the paper size and make the page
-% size more like a typical published manual.
-%\renewcommand{\paperheight}{9in}
-%\renewcommand{\paperwidth}{8.5in} % typical squarish manual
-%\renewcommand{\paperwidth}{7in} % O'Reilly ``Programmming Python''
-
-% use pdfoutput for pTeX and dvipdfmx
-% when pTeX (\kanjiskip is defined), set pdfoutput to evade \include{pdfcolor}
-\ifx\kanjiskip\undefined\else
- \newcount\pdfoutput\pdfoutput=0
+\ifx\@jsc@uplatextrue\@undefined\else
+ \PassOptionsToPackage{setpagesize=false}{hyperref}
\fi
-\RequirePackage{graphicx}
+% These options can be overriden inside 'hyperref' key
+% or by later use of \hypersetup.
+\PassOptionsToPackage{colorlinks,breaklinks,%
+ linkcolor=InnerLinkColor,filecolor=OuterLinkColor,%
+ menucolor=OuterLinkColor,urlcolor=OuterLinkColor,%
+ citecolor=InnerLinkColor}{hyperref}
+
+% stylesheet for highlighting with pygments
+\RequirePackage{sphinxhighlight}
+% fix baseline increase from Pygments latex formatter in case of error tokens
+% and keep \fboxsep's scope local via added braces
+\def\PYG@tok@err{%
+ \def\PYG@bc##1{{\setlength{\fboxsep}{-\fboxrule}%
+ \fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}%
+}
+\def\PYG@tok@cs{%
+ \def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}%
+ \def\PYG@bc##1{{\setlength{\fboxsep}{0pt}%
+ \colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}%
+}%
-% for PDF output, use colors and maximal compression
-\newif\ifsphinxpdfoutput % used in \maketitle
-\ifx\pdfoutput\undefined\else
- \ifnum\pdfoutput=\z@
- \let\py@NormalColor\relax
- \let\py@TitleColor\relax
- \else
- \sphinxpdfoutputtrue
- \input{pdfcolor}
- \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}}
- \def\py@TitleColor{\color{TitleColor}}
- \pdfcompresslevel=9
- \fi
-\fi
-% XeLaTeX can do colors, too
-\ifx\XeTeXrevision\undefined\else
- \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}}
- \def\py@TitleColor{\color{TitleColor}}
+%% OPTIONS
+%
+% Handle options via "kvoptions" (later loaded by hyperref anyhow)
+\RequirePackage{kvoptions}
+\SetupKeyvalOptions{prefix=spx@opt@} % use \spx@opt@ prefix
+
+% Sphinx legacy text layout: 1in margins on all four sides
+\ifx\@jsc@uplatextrue\@undefined
+\DeclareStringOption[1in]{hmargin}
+\DeclareStringOption[1in]{vmargin}
+\DeclareStringOption[.5in]{marginpar}
+\else
+% Japanese standard document classes handle \mag in a special way
+\DeclareStringOption[\inv@mag in]{hmargin}
+\DeclareStringOption[\inv@mag in]{vmargin}
+\DeclareStringOption[.5\dimexpr\inv@mag in\relax]{marginpar}
\fi
-% Increase printable page size (copied from fullpage.sty)
-\topmargin 0pt
-\advance \topmargin by -\headheight
-\advance \topmargin by -\headsep
-
-% attempt to work a little better for A4 users
-\textheight \paperheight
-\advance\textheight by -2in
+\DeclareStringOption[0]{maxlistdepth}% \newcommand*\spx@opt@maxlistdepth{0}
+\DeclareStringOption[-1]{numfigreset}
+\DeclareBoolOption[false]{nonumfigreset}
+\DeclareBoolOption[false]{mathnumfig}
+% \DeclareBoolOption[false]{usespart}% not used
+% dimensions, we declare the \dimen registers here.
+\newdimen\sphinxverbatimsep
+\newdimen\sphinxverbatimborder
+\newdimen\sphinxshadowsep
+\newdimen\sphinxshadowsize
+\newdimen\sphinxshadowrule
+% \DeclareStringOption is not convenient for the handling of these dimensions
+% because we want to assign the values to the corresponding registers. Even if
+% we added the code to the key handler it would be too late for the initial
+% set-up and we would need to do initial assignments explicitely. We end up
+% using \define@key directly.
+% verbatim
+\sphinxverbatimsep=\fboxsep
+ \define@key{sphinx}{verbatimsep}{\sphinxverbatimsep\dimexpr #1\relax}
+\sphinxverbatimborder=\fboxrule
+ \define@key{sphinx}{verbatimborder}{\sphinxverbatimborder\dimexpr #1\relax}
+% topic boxes
+\sphinxshadowsep =5pt
+ \define@key{sphinx}{shadowsep}{\sphinxshadowsep\dimexpr #1\relax}
+\sphinxshadowsize=4pt
+ \define@key{sphinx}{shadowsize}{\sphinxshadowsize\dimexpr #1\relax}
+\sphinxshadowrule=\fboxrule
+ \define@key{sphinx}{shadowrule}{\sphinxshadowrule\dimexpr #1\relax}
+% verbatim
+\DeclareBoolOption[true]{verbatimwithframe}
+\DeclareBoolOption[true]{verbatimwrapslines}
+\DeclareBoolOption[true]{verbatimhintsturnover}
+\DeclareBoolOption[true]{inlineliteralwraps}
+\DeclareStringOption[t]{literalblockcappos}
+\DeclareStringOption[r]{verbatimcontinuedalign}
+\DeclareStringOption[r]{verbatimcontinuesalign}
+% parsed literal
+\DeclareBoolOption[true]{parsedliteralwraps}
+% \textvisiblespace for compatibility with fontspec+XeTeX/LuaTeX
+\DeclareStringOption[\textcolor{red}{\textvisiblespace}]{verbatimvisiblespace}
+\DeclareStringOption % must use braces to hide the brackets
+ [{\makebox[2\fontcharwd\font`\x][r]{\textcolor{red}{\tiny$\m@th\hookrightarrow$}}}]%
+ {verbatimcontinued}
+% notices/admonitions
+% the dimensions for notices/admonitions are kept as macros and assigned to
+% \spx@notice@border at time of use, hence \DeclareStringOption is ok for this
+\newdimen\spx@notice@border
+\DeclareStringOption[0.5pt]{noteborder}
+\DeclareStringOption[0.5pt]{hintborder}
+\DeclareStringOption[0.5pt]{importantborder}
+\DeclareStringOption[0.5pt]{tipborder}
+\DeclareStringOption[1pt]{warningborder}
+\DeclareStringOption[1pt]{cautionborder}
+\DeclareStringOption[1pt]{attentionborder}
+\DeclareStringOption[1pt]{dangerborder}
+\DeclareStringOption[1pt]{errorborder}
+% footnotes
+\DeclareStringOption[\mbox{ }]{AtStartFootnote}
+% we need a public macro name for direct use in latex file
+\newcommand*{\sphinxAtStartFootnote}{\spx@opt@AtStartFootnote}
+% no such need for this one, as it is used inside other macros
+\DeclareStringOption[\leavevmode\unskip]{BeforeFootnote}
+% some font styling.
+\DeclareStringOption[\sffamily\bfseries]{HeaderFamily}
+% colours
+% same problems as for dimensions: we want the key handler to use \definecolor.
+% first, some colours with no prefix, for backwards compatibility
+\newcommand*{\sphinxDeclareColorOption}[2]{%
+ \definecolor{#1}#2%
+ \define@key{sphinx}{#1}{\definecolor{#1}##1}%
+}%
+\sphinxDeclareColorOption{TitleColor}{{rgb}{0.126,0.263,0.361}}
+\sphinxDeclareColorOption{InnerLinkColor}{{rgb}{0.208,0.374,0.486}}
+\sphinxDeclareColorOption{OuterLinkColor}{{rgb}{0.216,0.439,0.388}}
+\sphinxDeclareColorOption{VerbatimColor}{{rgb}{1,1,1}}
+\sphinxDeclareColorOption{VerbatimBorderColor}{{rgb}{0,0,0}}
+% now the colours defined with "sphinx" prefix in their names
+\newcommand*{\sphinxDeclareSphinxColorOption}[2]{%
+ % set the initial default
+ \definecolor{sphinx#1}#2%
+ % set the key handler. The "value" ##1 must be acceptable by \definecolor.
+ \define@key{sphinx}{#1}{\definecolor{sphinx#1}##1}%
+}%
+% Default color chosen to be as in minted.sty LaTeX package!
+\sphinxDeclareSphinxColorOption{VerbatimHighlightColor}{{rgb}{0.878,1,1}}
+% admonition boxes, "light" style
+\sphinxDeclareSphinxColorOption{noteBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{hintBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{importantBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{tipBorderColor}{{rgb}{0,0,0}}
+% admonition boxes, "heavy" style
+\sphinxDeclareSphinxColorOption{warningBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{cautionBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{attentionBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{dangerBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{errorBorderColor}{{rgb}{0,0,0}}
+\sphinxDeclareSphinxColorOption{warningBgColor}{{rgb}{1,1,1}}
+\sphinxDeclareSphinxColorOption{cautionBgColor}{{rgb}{1,1,1}}
+\sphinxDeclareSphinxColorOption{attentionBgColor}{{rgb}{1,1,1}}
+\sphinxDeclareSphinxColorOption{dangerBgColor}{{rgb}{1,1,1}}
+\sphinxDeclareSphinxColorOption{errorBgColor}{{rgb}{1,1,1}}
+
+\DeclareDefaultOption{\@unknownoptionerror}
+\ProcessKeyvalOptions*
+% don't allow use of maxlistdepth via \sphinxsetup.
+\DisableKeyvalOption{sphinx}{maxlistdepth}
+\DisableKeyvalOption{sphinx}{numfigreset}
+\DisableKeyvalOption{sphinx}{nonumfigreset}
+\DisableKeyvalOption{sphinx}{mathnumfig}
+% user interface: options can be changed midway in a document!
+\newcommand\sphinxsetup[1]{\setkeys{sphinx}{#1}}
+
+
+%% MAXLISTDEPTH
+%
+% remove LaTeX's cap on nesting depth if 'maxlistdepth' key used.
+% This is a hack, which works with the standard classes: it assumes \@toodeep
+% is always used in "true" branches: "\if ... \@toodeep \else .. \fi."
+
+% will force use the "false" branch (if there is one)
+\def\spx@toodeep@hack{\fi\iffalse}
+
+% do nothing if 'maxlistdepth' key not used or if package enumitem loaded.
+\ifnum\spx@opt@maxlistdepth=\z@\expandafter\@gobbletwo\fi
+\AtBeginDocument{%
+\@ifpackageloaded{enumitem}{\remove@to@nnil}{}%
+ \let\spx@toodeepORI\@toodeep
+ \def\@toodeep{%
+ \ifnum\@listdepth<\spx@opt@maxlistdepth\relax
+ \expandafter\spx@toodeep@hack
+ \else
+ \expandafter\spx@toodeepORI
+ \fi}%
+% define all missing \@list... macros
+ \count@\@ne
+ \loop
+ \ltx@ifundefined{@list\romannumeral\the\count@}
+ {\iffalse}{\iftrue\advance\count@\@ne}%
+ \repeat
+ \loop
+ \ifnum\count@>\spx@opt@maxlistdepth\relax\else
+ \expandafter\let
+ \csname @list\romannumeral\the\count@\expandafter\endcsname
+ \csname @list\romannumeral\the\numexpr\count@-\@ne\endcsname
+ % workaround 2.6--3.2d babel-french issue (fixed in 3.2e; no change needed)
+ \ltx@ifundefined{leftmargin\romannumeral\the\count@}
+ {\expandafter\let
+ \csname leftmargin\romannumeral\the\count@\expandafter\endcsname
+ \csname leftmargin\romannumeral\the\numexpr\count@-\@ne\endcsname}{}%
+ \advance\count@\@ne
+ \repeat
+% define all missing enum... counters and \labelenum... macros and \p@enum..
+ \count@\@ne
+ \loop
+ \ltx@ifundefined{c@enum\romannumeral\the\count@}
+ {\iffalse}{\iftrue\advance\count@\@ne}%
+ \repeat
+ \loop
+ \ifnum\count@>\spx@opt@maxlistdepth\relax\else
+ \newcounter{enum\romannumeral\the\count@}%
+ \expandafter\def
+ \csname labelenum\romannumeral\the\count@\expandafter\endcsname
+ \expandafter
+ {\csname theenum\romannumeral\the\numexpr\count@\endcsname.}%
+ \expandafter\def
+ \csname p@enum\romannumeral\the\count@\expandafter\endcsname
+ \expandafter
+ {\csname p@enum\romannumeral\the\numexpr\count@-\@ne\expandafter
+ \endcsname\csname theenum\romannumeral\the\numexpr\count@-\@ne\endcsname.}%
+ \advance\count@\@ne
+ \repeat
+% define all missing labelitem... macros
+ \count@\@ne
+ \loop
+ \ltx@ifundefined{labelitem\romannumeral\the\count@}
+ {\iffalse}{\iftrue\advance\count@\@ne}%
+ \repeat
+ \loop
+ \ifnum\count@>\spx@opt@maxlistdepth\relax\else
+ \expandafter\let
+ \csname labelitem\romannumeral\the\count@\expandafter\endcsname
+ \csname labelitem\romannumeral\the\numexpr\count@-\@ne\endcsname
+ \advance\count@\@ne
+ \repeat
+ \PackageInfo{sphinx}{maximal list depth extended to \spx@opt@maxlistdepth}%
+\@gobble\@nnil
+}
-\oddsidemargin 0pt
-\evensidemargin 0pt
-%\evensidemargin -.25in % for ``manual size'' documents
-\marginparwidth 0.5in
-\textwidth \paperwidth
-\advance\textwidth by -2in
+%% INDEX, BIBLIOGRAPHY, APPENDIX, TABLE OF CONTENTS
+%
+% fix the double index and bibliography on the table of contents
+% in jsclasses (Japanese standard document classes)
+\ifx\@jsc@uplatextrue\@undefined\else
+ \renewenvironment{sphinxtheindex}
+ {\cleardoublepage\phantomsection
+ \begin{theindex}}
+ {\end{theindex}}
+
+ \renewenvironment{sphinxthebibliography}[1]
+ {\cleardoublepage% \phantomsection % not needed here since TeXLive 2010's hyperref
+ \begin{thebibliography}{#1}}
+ {\end{thebibliography}}
+\fi
+% disable \@chappos in Appendix in pTeX
+\ifx\kanjiskip\@undefined\else
+ \let\py@OldAppendix=\appendix
+ \renewcommand{\appendix}{
+ \py@OldAppendix
+ \gdef\@chappos{}
+ }
+\fi
+% make commands known to non-Sphinx document classes
+\providecommand*{\sphinxtableofcontents}{\tableofcontents}
+\ltx@ifundefined{sphinxthebibliography}
+ {\newenvironment
+ {sphinxthebibliography}{\begin{thebibliography}}{\end{thebibliography}}%
+ }
+ {}% else clause of \ltx@ifundefined
+\ltx@ifundefined{sphinxtheindex}
+ {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}%
+ {}% else clause of \ltx@ifundefined
+
+% for usage with xindy: this string gets internationalized in preamble
+\newcommand*{\sphinxnonalphabeticalgroupname}{}
+% redefined in preamble, headings for makeindex produced index
+\newcommand*{\sphinxsymbolsname}{}
+\newcommand*{\sphinxnumbersname}{}
+
+%% COLOR (general)
+%
+% FIXME: \normalcolor should probably be used in place of \py@NormalColor
+% elsewhere, and \py@NormalColor should never be defined. \normalcolor
+% switches to the colour from last \color call in preamble.
+\def\py@NormalColor{\color{black}}
+% FIXME: it is probably better to use \color{TitleColor}, as TitleColor
+% can be customized from 'sphinxsetup', and drop usage of \py@TitleColor
+\def\py@TitleColor{\color{TitleColor}}
+% FIXME: this line should be dropped, as "9" is default anyhow.
+\ifdefined\pdfcompresslevel\pdfcompresslevel = 9 \fi
+
+
+%% PAGE STYLING
+%
% Style parameters and macros used by most documents here
\raggedbottom
\sloppy
@@ -132,23 +501,21 @@
\pagestyle{empty} % start this way
-% Use this to set the font family for headers and other decor:
-\newcommand{\py@HeaderFamily}{\sffamily\bfseries}
-\newcommand{\sphinxSetHeaderFamily}[1]{\renewcommand{\py@HeaderFamily}{#1}}
-
% Redefine the 'normal' header/footer style when using "fancyhdr" package:
-\spx@ifundefined{fancyhf}{}{
+% Note: this presupposes "twoside". If "oneside" class option, there will be warnings.
+\ltx@ifundefined{fancyhf}{}{
% Use \pagestyle{normal} as the primary pagestyle for text.
\fancypagestyle{normal}{
\fancyhf{}
+% (for \py@HeaderFamily cf "TITLES")
\fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
\fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
\fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}
- \fancyhead[LE,RO]{{\py@HeaderFamily \@title, \py@release}}
+ \fancyhead[LE,RO]{{\py@HeaderFamily \@title\sphinxheadercomma\py@release}}
\renewcommand{\headrulewidth}{0.4pt}
\renewcommand{\footrulewidth}{0.4pt}
% define chaptermark with \@chappos when \@chappos is available for Japanese
- \spx@ifundefined{@chappos}{}
+ \ltx@ifundefined{@chappos}{}
{\def\chaptermark##1{\markboth{\@chapapp\space\thechapter\space\@chappos\space ##1}{}}}
}
% Update the plain style so we get the page number & footer line,
@@ -162,164 +529,490 @@
}
}
-% Some custom font markup commands.
-% *** the macros without \sphinx prefix are still defined at bottom of file ***
-\newcommand{\sphinxstrong}[1]{{\textbf{#1}}}
-% let \sphinxcode and \sphinxbfcode use straight quotes. \@noligs patched by upquote,
-% but needs protection in "moving arguments" such as for captions.
-% Use \scantokens to handle e.g. \item[{\sphinxcode{'fontenc'}}]
-\DeclareRobustCommand{\sphinxcode}[1]{{\@noligs\scantokens{\texttt{#1}\relax}}}
-\newcommand{\sphinxbfcode}[1]{\sphinxcode{\bfseries#1}}
-\newcommand{\sphinxemail}[1]{\textsf{#1}}
-\newcommand{\sphinxtablecontinued}[1]{\textsf{#1}}
-\newcommand{\sphinxtitleref}[1]{\emph{#1}}
-\newcommand{\sphinxmenuselection}[1]{\emph{#1}}
-\newcommand{\sphinxaccelerator}[1]{\underline{#1}}
-\newcommand{\sphinxcrossref}[1]{\emph{#1}}
-\newcommand{\sphinxtermref}[1]{\emph{#1}}
-
-% miscellaneous related to footnotes
-\newcommand*{\sphinxAtStartFootnote}{\mbox{ }}
-% Support large numbered footnotes in minipage (cf. admonitions)
+% geometry
+\ifx\kanjiskip\@undefined
+ \PassOptionsToPackage{%
+ hmargin={\unexpanded{\spx@opt@hmargin}},%
+ vmargin={\unexpanded{\spx@opt@vmargin}},%
+ marginpar=\unexpanded{\spx@opt@marginpar}}
+ {geometry}
+\else
+ % set text width for Japanese documents to be integer multiple of 1zw
+ % and text height to be integer multiple of \baselineskip
+ % the execution is delayed to \sphinxsetup then geometry.sty
+ \normalsize\normalfont
+ \newcommand*\sphinxtextwidthja[1]{%
+ \if@twocolumn\tw@\fi
+ \dimexpr
+ \numexpr\dimexpr\paperwidth-\tw@\dimexpr#1\relax\relax/
+ \dimexpr\if@twocolumn\tw@\else\@ne\fi zw\relax
+ zw\relax}%
+ \newcommand*\sphinxmarginparwidthja[1]{%
+ \dimexpr\numexpr\dimexpr#1\relax/\dimexpr1zw\relax zw\relax}%
+ \newcommand*\sphinxtextlinesja[1]{%
+ \numexpr\@ne+\dimexpr\paperheight-\topskip-\tw@\dimexpr#1\relax\relax/
+ \baselineskip\relax}%
+ \ifx\@jsc@uplatextrue\@undefined\else
+ % the way we found in order for the papersize special written by
+ % geometry in the dvi file to be correct in case of jsbook class
+ \ifnum\mag=\@m\else % do nothing special if nomag class option or 10pt
+ \PassOptionsToPackage{truedimen}{geometry}%
+ \fi
+ \fi
+ \PassOptionsToPackage{%
+ hmarginratio={1:1},%
+ textwidth=\unexpanded{\sphinxtextwidthja{\spx@opt@hmargin}},%
+ vmarginratio={1:1},%
+ lines=\unexpanded{\sphinxtextlinesja{\spx@opt@vmargin}},%
+ marginpar=\unexpanded{\sphinxmarginparwidthja{\spx@opt@marginpar}},%
+ footskip=2\baselineskip,%
+ }{geometry}%
+ \AtBeginDocument
+ {% update a dimension used by the jsclasses
+ \ifx\@jsc@uplatextrue\@undefined\else\fullwidth\textwidth\fi
+ % for some reason, jreport normalizes all dimensions with \@settopoint
+ \@ifclassloaded{jreport}
+ {\@settopoint\textwidth\@settopoint\textheight\@settopoint\marginparwidth}
+ {}% <-- "false" clause of \@ifclassloaded
+ }%
+\fi
+
+% fix fncychap's bug which uses prematurely the \textwidth value
+\@ifpackagewith{fncychap}{Bjornstrup}
+ {\AtBeginDocument{\mylen\textwidth\advance\mylen-2\myhi}}%
+ {}% <-- "false" clause of \@ifpackagewith
+
+
+%% TITLES
+%
+% Since Sphinx 1.5, users should use HeaderFamily key to 'sphinxsetup' rather
+% than defining their own \py@HeaderFamily command (which is still possible).
+% Memo: \py@HeaderFamily is also used by \maketitle as defined in
+% sphinxmanual.cls/sphinxhowto.cls
+\newcommand{\py@HeaderFamily}{\spx@opt@HeaderFamily}
+
+% This sets up the fancy chapter headings that make the documents look
+% at least a little better than the usual LaTeX output.
+\@ifpackagewith{fncychap}{Bjarne}{
+ \ChNameVar {\raggedleft\normalsize \py@HeaderFamily}
+ \ChNumVar {\raggedleft\Large \py@HeaderFamily}
+ \ChTitleVar{\raggedleft\Large \py@HeaderFamily}
+ % This creates (numbered) chapter heads without the leading \vspace*{}:
+ \def\@makechapterhead#1{%
+ {\parindent \z@ \raggedright \normalfont
+ \ifnum \c@secnumdepth >\m@ne
+ \if@mainmatter
+ \DOCH
+ \fi
+ \fi
+ \interlinepenalty\@M
+ \if@mainmatter
+ \DOTI{#1}%
+ \else%
+ \DOTIS{#1}%
+ \fi
+ }}
+}{}% <-- "false" clause of \@ifpackagewith
+
+% Augment the sectioning commands used to get our own font family in place,
+% and reset some internal data items (\titleformat from titlesec package)
+\titleformat{\section}{\Large\py@HeaderFamily}%
+ {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subsection}{\large\py@HeaderFamily}%
+ {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subsubsection}{\py@HeaderFamily}%
+ {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
+% By default paragraphs (and subsubsections) will not be numbered because
+% sphinxmanual.cls and sphinxhowto.cls set secnumdepth to 2
+\titleformat{\paragraph}{\py@HeaderFamily}%
+ {\py@TitleColor\theparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
+\titleformat{\subparagraph}{\py@HeaderFamily}%
+ {\py@TitleColor\thesubparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
+
+
+%% GRAPHICS
+%
+% \sphinxincludegraphics defined to resize images larger than the line width,
+% except if height or width option present.
+%
+% If scale is present, rescale before fitting to line width. (since 1.5)
+\newbox\spx@image@box
+\newcommand*{\sphinxincludegraphics}[2][]{%
+ \in@{height}{#1}\ifin@\else\in@{width}{#1}\fi
+ \ifin@ % height or width present
+ \includegraphics[#1]{#2}%
+ \else % no height nor width (but #1 may be "scale=...")
+ \setbox\spx@image@box\hbox{\includegraphics[#1,draft]{#2}}%
+ \ifdim \wd\spx@image@box>\linewidth
+ \setbox\spx@image@box\box\voidb@x % clear memory
+ \includegraphics[#1,width=\linewidth]{#2}%
+ \else
+ \includegraphics[#1]{#2}%
+ \fi
+ \fi
+}
+
+
+%% FIGURE IN TABLE
+%
+\newenvironment{sphinxfigure-in-table}[1][\linewidth]{%
+ \def\@captype{figure}%
+ \sphinxsetvskipsforfigintablecaption
+ \begin{minipage}{#1}%
+}{\end{minipage}}
+% store original \caption macro for use with figures in longtable and tabulary
+\AtBeginDocument{\let\spx@originalcaption\caption}
+\newcommand*\sphinxfigcaption
+ {\ifx\equation$%$% this is trick to identify tabulary first pass
+ \firstchoice@false\else\firstchoice@true\fi
+ \spx@originalcaption }
+\newcommand*\sphinxsetvskipsforfigintablecaption
+ {\abovecaptionskip\smallskipamount
+ \belowcaptionskip\smallskipamount}
+
+
+%% CITATIONS
+%
+\protected\def\sphinxcite{\cite}
+
+%% FOOTNOTES
+%
+% Support large numbered footnotes in minipage
+% But now obsolete due to systematic use of \savenotes/\spewnotes
+% when minipages are in use in the various macro definitions next.
\def\thempfootnote{\arabic{mpfootnote}}
-% Redefine the Verbatim environment to allow border and background colors
-% and to handle the top caption in a non separable by pagebreak way.
-% The original environment is still used for verbatims within tables.
-\let\OriginalVerbatim=\Verbatim
-\let\endOriginalVerbatim=\endVerbatim
-\newcommand\spx@colorbox [2]{%
-% #1 will be \fcolorbox or, for first part of frame: \spx@fcolorbox
-% let the framing obey the current indentation (adapted from framed.sty's code).
+%% NUMBERING OF FIGURES, TABLES, AND LITERAL BLOCKS
+\ltx@ifundefined{c@chapter}
+ {\newcounter{literalblock}}%
+ {\newcounter{literalblock}[chapter]%
+ \def\theliteralblock{\ifnum\c@chapter>\z@\arabic{chapter}.\fi
+ \arabic{literalblock}}%
+ }%
+\ifspx@opt@nonumfigreset
+ \ltx@ifundefined{c@chapter}{}{%
+ \@removefromreset{figure}{chapter}%
+ \@removefromreset{table}{chapter}%
+ \@removefromreset{literalblock}{chapter}%
+ \ifspx@opt@mathnumfig
+ \@removefromreset{equation}{chapter}%
+ \fi
+ }%
+ \def\thefigure{\arabic{figure}}%
+ \def\thetable {\arabic{table}}%
+ \def\theliteralblock{\arabic{literalblock}}%
+ \ifspx@opt@mathnumfig
+ \def\theequation{\arabic{equation}}%
+ \fi
+\else
+\let\spx@preAthefigure\@empty
+\let\spx@preBthefigure\@empty
+% \ifspx@opt@usespart % <-- LaTeX writer could pass such a 'usespart' boolean
+% % as sphinx.sty package option
+% If document uses \part, (triggered in Sphinx by latex_toplevel_sectioning)
+% LaTeX core per default does not reset chapter or section
+% counters at each part.
+% But if we modify this, we need to redefine \thechapter, \thesection to
+% include the part number and this will cause problems in table of contents
+% because of too wide numbering. Simplest is to do nothing.
+% \fi
+\ifnum\spx@opt@numfigreset>0
+ \ltx@ifundefined{c@chapter}
+ {}
+ {\g@addto@macro\spx@preAthefigure{\ifnum\c@chapter>\z@\arabic{chapter}.}%
+ \g@addto@macro\spx@preBthefigure{\fi}}%
+\fi
+\ifnum\spx@opt@numfigreset>1
+ \@addtoreset{figure}{section}%
+ \@addtoreset{table}{section}%
+ \@addtoreset{literalblock}{section}%
+ \ifspx@opt@mathnumfig
+ \@addtoreset{equation}{section}%
+ \fi
+ \g@addto@macro\spx@preAthefigure{\ifnum\c@section>\z@\arabic{section}.}%
+ \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\ifnum\spx@opt@numfigreset>2
+ \@addtoreset{figure}{subsection}%
+ \@addtoreset{table}{subsection}%
+ \@addtoreset{literalblock}{subsection}%
+ \ifspx@opt@mathnumfig
+ \@addtoreset{equation}{subsection}%
+ \fi
+ \g@addto@macro\spx@preAthefigure{\ifnum\c@subsection>\z@\arabic{subsection}.}%
+ \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\ifnum\spx@opt@numfigreset>3
+ \@addtoreset{figure}{subsubsection}%
+ \@addtoreset{table}{subsubsection}%
+ \@addtoreset{literalblock}{subsubsection}%
+ \ifspx@opt@mathnumfig
+ \@addtoreset{equation}{subsubsection}%
+ \fi
+ \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubsection>\z@\arabic{subsubsection}.}%
+ \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\ifnum\spx@opt@numfigreset>4
+ \@addtoreset{figure}{paragraph}%
+ \@addtoreset{table}{paragraph}%
+ \@addtoreset{literalblock}{paragraph}%
+ \ifspx@opt@mathnumfig
+ \@addtoreset{equation}{paragraph}%
+ \fi
+ \g@addto@macro\spx@preAthefigure{\ifnum\c@subparagraph>\z@\arabic{subparagraph}.}%
+ \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\ifnum\spx@opt@numfigreset>5
+ \@addtoreset{figure}{subparagraph}%
+ \@addtoreset{table}{subparagraph}%
+ \@addtoreset{literalblock}{subparagraph}%
+ \ifspx@opt@mathnumfig
+ \@addtoreset{equation}{subparagraph}%
+ \fi
+ \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubparagraph>\z@\arabic{subsubparagraph}.}%
+ \g@addto@macro\spx@preBthefigure{\fi}%
+\fi
+\expandafter\g@addto@macro
+\expandafter\spx@preAthefigure\expandafter{\spx@preBthefigure}%
+\let\thefigure\spx@preAthefigure
+\let\thetable\spx@preAthefigure
+\let\theliteralblock\spx@preAthefigure
+\g@addto@macro\thefigure{\arabic{figure}}%
+\g@addto@macro\thetable{\arabic{table}}%
+\g@addto@macro\theliteralblock{\arabic{literalblock}}%
+ \ifspx@opt@mathnumfig
+ \let\theequation\spx@preAthefigure
+ \g@addto@macro\theequation{\arabic{equation}}%
+ \fi
+\fi
+
+
+%% LITERAL BLOCKS
+%
+% Based on use of "fancyvrb.sty"'s Verbatim.
+% - with framing allowing page breaks ("framed.sty")
+% - with breaking of long lines (exploits Pygments mark-up),
+% - with possibly of a top caption, non-separable by pagebreak.
+% - and usable inside tables or footnotes ("footnotehyper-sphinx").
+
+% For extensions which use \OriginalVerbatim and compatibility with Sphinx <
+% 1.5, we define and use these when (unmodified) Verbatim will be needed. But
+% Sphinx >= 1.5 does not modify the \Verbatim macro anymore.
+\let\OriginalVerbatim \Verbatim
+\let\endOriginalVerbatim\endVerbatim
+
+% for captions of literal blocks
+% at start of caption title
+\newcommand*{\fnum@literalblock}{\literalblockname\nobreakspace\theliteralblock}
+% this will be overwritten in document preamble by Babel translation
+\newcommand*{\literalblockname}{Listing }
+% file extension needed for \caption's good functioning, the file is created
+% only if a \listof{literalblock}{foo} command is encountered, which is
+% analogous to \listoffigures, but for the code listings (foo = chosen title.)
+\newcommand*{\ext@literalblock}{lol}
+
+\newif\ifspx@inframed % flag set if we are already in a framed environment
+% if forced use of minipage encapsulation is needed (e.g. table cells)
+\newif\ifsphinxverbatimwithminipage \sphinxverbatimwithminipagefalse
+
+% Framing macro for use with framed.sty's \FrameCommand
+% - it obeys current indentation,
+% - frame is \fboxsep separated from the contents,
+% - the contents use the full available text width,
+% - #1 = color of frame, #2 = color of background,
+% - #3 = above frame, #4 = below frame, #5 = within frame,
+% - #3 and #4 must be already typeset boxes; they must issue \normalcolor
+% or similar, else, they are under scope of color #1
+\long\def\spx@fcolorbox #1#2#3#4#5{%
\hskip\@totalleftmargin
\hskip-\fboxsep\hskip-\fboxrule
- #1{VerbatimBorderColor}{VerbatimColor}{#2}%
+ % use of \color@b@x here is compatible with both xcolor.sty and color.sty
+ \color@b@x {\color{#1}\spx@CustomFBox{#3}{#4}}{\color{#2}}{#5}%
\hskip-\fboxsep\hskip-\fboxrule
\hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth
-}
-% use of \color@b@x here is compatible with both xcolor.sty and color.sty
-\def\spx@fcolorbox #1#2%
- {\color@b@x {\fboxsep\z@\color{#1}\spx@VerbatimFBox}{\color{#2}}}%
-
-% The title is specified from outside as macro \sphinxVerbatimTitle.
-% \sphinxVerbatimTitle is reset to empty after each use of Verbatim.
-\newcommand*\sphinxVerbatimTitle {}
-% Holder macro for labels of literal blocks. Set-up by LaTeX writer.
-\newcommand*\sphinxLiteralBlockLabel {}
-\newcommand*\sphinxSetupCaptionForVerbatim [2]
-{%
- \needspace{\sphinxliteralblockneedspace}%
-% insert a \label via \sphinxLiteralBlockLabel
-% reset to normal the color for the literal block caption
-% the caption inserts \abovecaptionskip whitespace above itself (usually 10pt)
-% there is also \belowcaptionskip but it is usually zero, hence the \smallskip
- \def\sphinxVerbatimTitle
- {\py@NormalColor\captionof{#1}{\sphinxLiteralBlockLabel #2}\smallskip }%
-}
-
-% Inspired and adapted from framed.sty's \CustomFBox with extra handling
-% of a non separable by pagebreak caption, and controlled counter stepping.
-\newif\ifspx@myfirstframedpass
-\long\def\spx@VerbatimFBox#1{%
- \leavevmode
+}%
+% #1 = for material above frame, such as a caption or a "continued" hint
+% #2 = for material below frame, such as a caption or "continues on next page"
+% #3 = actual contents, which will be typeset with a background color
+\long\def\spx@CustomFBox#1#2#3{%
\begingroup
- % framed.sty does some measuring but this macro adds possibly a caption
- % use amsmath conditional to inhibit the caption counter stepping after
- % first pass
- \ifspx@myfirstframedpass\else\firstchoice@false\fi
- \setbox\@tempboxa\hbox{\kern\fboxsep{#1}\kern\fboxsep}%
- \hbox
- {\lower\dimexpr\fboxrule+\fboxsep+\dp\@tempboxa
- \hbox{%
- \vbox{\ifx\sphinxVerbatimTitle\empty\else
- % add the caption in a centered way above possibly indented frame
- % hide its width from framed.sty's measuring step
- % note that the caption brings \abovecaptionskip top vertical space
- \moveright\dimexpr\fboxrule+.5\wd\@tempboxa
- \hb@xt@\z@{\hss\begin{minipage}{\wd\@tempboxa}%
- \sphinxVerbatimTitle
- \end{minipage}\hss}\fi
+ \setbox\@tempboxa\hbox{{#3}}% inner braces to avoid color leaks
+ \vbox{#1% above frame
% draw frame border _latest_ to avoid pdf viewer issue
\kern\fboxrule
\hbox{\kern\fboxrule
- \vbox{\vskip\fboxsep\copy\@tempboxa\vskip\fboxsep}%
+ \copy\@tempboxa
\kern-\wd\@tempboxa\kern-\fboxrule
\vrule\@width\fboxrule
\kern\wd\@tempboxa
\vrule\@width\fboxrule}%
- \kern-\dimexpr\fboxsep+\ht\@tempboxa+\dp\@tempboxa
- +\fboxsep+\fboxrule\relax
+ \kern-\dimexpr\ht\@tempboxa+\dp\@tempboxa+\fboxrule\relax
+ \hrule\@height\fboxrule
+ \kern\dimexpr\ht\@tempboxa+\dp\@tempboxa\relax
\hrule\@height\fboxrule
- \kern\dimexpr\fboxsep+\ht\@tempboxa+\dp\@tempboxa+\fboxsep\relax
- \hrule\@height\fboxrule}%
- }}%
+ #2% below frame
+ }%
\endgroup
- \global\spx@myfirstframedpassfalse
-}
+}%
+\def\spx@fcolorbox@put@c#1{% hide width from framed.sty measuring
+ \moveright\dimexpr\fboxrule+.5\wd\@tempboxa\hb@xt@\z@{\hss#1\hss}%
+}%
+\def\spx@fcolorbox@put@r#1{% right align with contents, width hidden
+ \moveright\dimexpr\fboxrule+\wd\@tempboxa-\fboxsep\hb@xt@\z@{\hss#1}%
+}%
+\def\spx@fcolorbox@put@l#1{% left align with contents, width hidden
+ \moveright\dimexpr\fboxrule+\fboxsep\hb@xt@\z@{#1\hss}%
+}%
+%
+\def\sphinxVerbatim@Continued
+ {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuedalign\endcsname
+ {\normalcolor\sphinxstylecodecontinued\literalblockcontinuedname}}%
+\def\sphinxVerbatim@Continues
+ {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuesalign\endcsname
+ {\normalcolor\sphinxstylecodecontinues\literalblockcontinuesname}}%
+\def\sphinxVerbatim@Title
+ {\spx@fcolorbox@put@c{\unhcopy\sphinxVerbatim@TitleBox}}%
+\let\sphinxVerbatim@Before\@empty
+\let\sphinxVerbatim@After\@empty
+% Defaults are redefined in document preamble according to language
+\newcommand*\literalblockcontinuedname{continued from previous page}%
+\newcommand*\literalblockcontinuesname{continues on next page}%
+%
+\def\spx@verbatimfcolorbox{\spx@fcolorbox{VerbatimBorderColor}{VerbatimColor}}%
+\def\sphinxVerbatim@FrameCommand
+ {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@After}%
+\def\sphinxVerbatim@FirstFrameCommand
+ {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@Continues}%
+\def\sphinxVerbatim@MidFrameCommand
+ {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@Continues}%
+\def\sphinxVerbatim@LastFrameCommand
+ {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@After}%
% For linebreaks inside Verbatim environment from package fancyvrb.
\newbox\sphinxcontinuationbox
\newbox\sphinxvisiblespacebox
-% These are user customizable e.g. from latex_elements's preamble key.
-% Use of \textvisiblespace for compatibility with XeTeX/LuaTeX/fontspec.
-\newcommand*\sphinxvisiblespace {\textcolor{red}{\textvisiblespace}}
-\newcommand*\sphinxcontinuationsymbol {\textcolor{red}{\llap{\tiny$\m@th\hookrightarrow$}}}
-\newcommand*\sphinxcontinuationindent {3ex }
-\newcommand*\sphinxafterbreak {\kern\sphinxcontinuationindent\copy\sphinxcontinuationbox}
+\newcommand*\sphinxafterbreak {\copy\sphinxcontinuationbox}
% Take advantage of the already applied Pygments mark-up to insert
% potential linebreaks for TeX processing.
% {, <, #, %, $, ' and ": go to next line.
% _, }, ^, &, >, - and ~: stay at end of broken line.
% Use of \textquotesingle for straight quote.
+% FIXME: convert this to package options ?
+\newcommand*\sphinxbreaksbeforelist {%
+ \do\PYGZob\{\do\PYGZlt\<\do\PYGZsh\#\do\PYGZpc\%% {, <, #, %,
+ \do\PYGZdl\$\do\PYGZdq\"% $, "
+ \def\PYGZsq
+ {\discretionary{}{\sphinxafterbreak\textquotesingle}{\textquotesingle}}% '
+}
+\newcommand*\sphinxbreaksafterlist {%
+ \do\PYGZus\_\do\PYGZcb\}\do\PYGZca\^\do\PYGZam\&% _, }, ^, &,
+ \do\PYGZgt\>\do\PYGZhy\-\do\PYGZti\~% >, -, ~
+}
\newcommand*\sphinxbreaksatspecials {%
- \def\PYGZus{\discretionary{\char`\_}{\sphinxafterbreak}{\char`\_}}%
- \def\PYGZob{\discretionary{}{\sphinxafterbreak\char`\{}{\char`\{}}%
- \def\PYGZcb{\discretionary{\char`\}}{\sphinxafterbreak}{\char`\}}}%
- \def\PYGZca{\discretionary{\char`\^}{\sphinxafterbreak}{\char`\^}}%
- \def\PYGZam{\discretionary{\char`\&}{\sphinxafterbreak}{\char`\&}}%
- \def\PYGZlt{\discretionary{}{\sphinxafterbreak\char`\<}{\char`\<}}%
- \def\PYGZgt{\discretionary{\char`\>}{\sphinxafterbreak}{\char`\>}}%
- \def\PYGZsh{\discretionary{}{\sphinxafterbreak\char`\#}{\char`\#}}%
- \def\PYGZpc{\discretionary{}{\sphinxafterbreak\char`\%}{\char`\%}}%
- \def\PYGZdl{\discretionary{}{\sphinxafterbreak\char`\$}{\char`\$}}%
- \def\PYGZhy{\discretionary{\char`\-}{\sphinxafterbreak}{\char`\-}}%
- \def\PYGZsq{\discretionary{}{\sphinxafterbreak\textquotesingle}{\textquotesingle}}%
- \def\PYGZdq{\discretionary{}{\sphinxafterbreak\char`\"}{\char`\"}}%
- \def\PYGZti{\discretionary{\char`\~}{\sphinxafterbreak}{\char`\~}}%
+ \def\do##1##2%
+ {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}%
+ \sphinxbreaksbeforelist
+ \def\do##1##2%
+ {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}%
+ \sphinxbreaksafterlist
}
\def\sphinx@verbatim@nolig@list {\do \`}%
% Some characters . , ; ? ! / are not pygmentized.
-% This macro makes them "active" and they will insert potential linebreaks
-\newcommand*\sphinxbreaksatpunct {%
- \lccode`\~`\.\lowercase{\def~}{\discretionary{\char`\.}{\sphinxafterbreak}{\char`\.}}%
- \lccode`\~`\,\lowercase{\def~}{\discretionary{\char`\,}{\sphinxafterbreak}{\char`\,}}%
- \lccode`\~`\;\lowercase{\def~}{\discretionary{\char`\;}{\sphinxafterbreak}{\char`\;}}%
- \lccode`\~`\:\lowercase{\def~}{\discretionary{\char`\:}{\sphinxafterbreak}{\char`\:}}%
- \lccode`\~`\?\lowercase{\def~}{\discretionary{\char`\?}{\sphinxafterbreak}{\char`\?}}%
- \lccode`\~`\!\lowercase{\def~}{\discretionary{\char`\!}{\sphinxafterbreak}{\char`\!}}%
- \lccode`\~`\/\lowercase{\def~}{\discretionary{\char`\/}{\sphinxafterbreak}{\char`\/}}%
- \catcode`\.\active
- \catcode`\,\active
- \catcode`\;\active
- \catcode`\:\active
- \catcode`\?\active
- \catcode`\!\active
- \catcode`\/\active
+% This macro makes them "active" and they will insert potential linebreaks.
+% Not compatible with math mode (cf \sphinxunactivateextras).
+\newcommand*\sphinxbreaksbeforeactivelist {}% none
+\newcommand*\sphinxbreaksafteractivelist {\do\.\do\,\do\;\do\?\do\!\do\/}
+\newcommand*\sphinxbreaksviaactive {%
+ \def\do##1{\lccode`\~`##1%
+ \lowercase{\def~}{\discretionary{}{\sphinxafterbreak\char`##1}{\char`##1}}%
+ \catcode`##1\active}%
+ \sphinxbreaksbeforeactivelist
+ \def\do##1{\lccode`\~`##1%
+ \lowercase{\def~}{\discretionary{\char`##1}{\sphinxafterbreak}{\char`##1}}%
+ \catcode`##1\active}%
+ \sphinxbreaksafteractivelist
\lccode`\~`\~
}
-\renewcommand{\Verbatim}[1][1]{%
- % quit horizontal mode if we are still in a paragraph
- \par
- % list starts new par, but we don't want it to be set apart vertically
- \parskip\z@skip
+% If the linebreak is at a space, the latter will be displayed as visible
+% space at end of first line, and a continuation symbol starts next line.
+\def\spx@verbatim@space {%
+ \nobreak\hskip\z@skip
+ \discretionary{\copy\sphinxvisiblespacebox}{\sphinxafterbreak}
+ {\kern\fontdimen2\font}%
+}%
+
+% if the available space on page is less than \literalblockneedspace, insert pagebreak
+\newcommand{\sphinxliteralblockneedspace}{5\baselineskip}
+\newcommand{\sphinxliteralblockwithoutcaptionneedspace}{1.5\baselineskip}
+% The title (caption) is specified from outside as macro \sphinxVerbatimTitle.
+% \sphinxVerbatimTitle is reset to empty after each use of Verbatim.
+\newcommand*\sphinxVerbatimTitle {}
+% This box to typeset the caption before framed.sty multiple passes for framing.
+\newbox\sphinxVerbatim@TitleBox
+% This is a workaround to a "feature" of French lists, when literal block
+% follows immediately; usable generally (does only \par then), a priori...
+\newcommand*\sphinxvspacefixafterfrenchlists{%
+ \ifvmode\ifdim\lastskip<\z@ \vskip\parskip\fi\else\par\fi
+}
+% Holder macro for labels of literal blocks. Set-up by LaTeX writer.
+\newcommand*\sphinxLiteralBlockLabel {}
+\newcommand*\sphinxSetupCaptionForVerbatim [1]
+{%
+ \sphinxvspacefixafterfrenchlists
+ \needspace{\sphinxliteralblockneedspace}%
+% insert a \label via \sphinxLiteralBlockLabel
+% reset to normal the color for the literal block caption
+ \def\sphinxVerbatimTitle
+ {\py@NormalColor\sphinxcaption{\sphinxLiteralBlockLabel #1}}%
+}
+\newcommand*\sphinxSetupCodeBlockInFootnote {%
+ \fvset{fontsize=\footnotesize}\let\caption\sphinxfigcaption
+ \sphinxverbatimwithminipagetrue % reduces vertical spaces
+ % we counteract (this is in a group) the \@normalsize from \caption
+ \let\normalsize\footnotesize\let\@parboxrestore\relax
+ \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}%
+}
+% needed to create wrapper environments of fancyvrb's Verbatim
+\newcommand*{\sphinxVerbatimEnvironment}{\gdef\FV@EnvironName{sphinxVerbatim}}
+\newcommand*{\sphinxverbatimsmallskipamount}{\smallskipamount}
+% serves to implement line highlighting and line wrapping
+\newcommand\sphinxFancyVerbFormatLine[1]{%
+ \expandafter\sphinx@verbatim@checkifhl\expandafter{\the\FV@CodeLineNo}%
+ \ifin@
+ \sphinxVerbatimHighlightLine{#1}%
+ \else
+ \sphinxVerbatimFormatLine{#1}%
+ \fi
+}%
+\newcommand\sphinxVerbatimHighlightLine[1]{%
+ \edef\sphinxrestorefboxsep{\fboxsep\the\fboxsep\relax}%
+ \fboxsep0pt\relax % cf LaTeX bug graphics/4524
+ \colorbox{sphinxVerbatimHighlightColor}%
+ {\sphinxrestorefboxsep\sphinxVerbatimFormatLine{#1}}%
+ % no need to restore \fboxsep here, as this ends up in a \hbox from fancyvrb
+}%
+% \sphinxVerbatimFormatLine will be set locally to one of those two:
+\newcommand\sphinxVerbatimFormatLineWrap[1]{%
+ \hsize\linewidth
+ \vtop{\raggedright\hyphenpenalty\z@\exhyphenpenalty\z@
+ \doublehyphendemerits\z@\finalhyphendemerits\z@
+ \strut #1\strut}%
+}%
+\newcommand\sphinxVerbatimFormatLineNoWrap[1]{\hb@xt@\linewidth{\strut #1\hss}}%
+\g@addto@macro\FV@SetupFont{%
+ \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}%
+ \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}%
+}%
+\newenvironment{sphinxVerbatim}{%
% first, let's check if there is a caption
\ifx\sphinxVerbatimTitle\empty
- \addvspace\z@% counteract possible previous negative skip (French lists!)
- \smallskip
+ \sphinxvspacefixafterfrenchlists
+ \parskip\z@skip
+ \vskip\sphinxverbatimsmallskipamount
% there was no caption. Check if nevertheless a label was set.
\ifx\sphinxLiteralBlockLabel\empty\else
% we require some space to be sure hyperlink target from \phantomsection
@@ -327,16 +1020,39 @@
\needspace{\sphinxliteralblockwithoutcaptionneedspace}%
\phantomsection\sphinxLiteralBlockLabel
\fi
+ \else
+ \parskip\z@skip
+ \if t\spx@opt@literalblockcappos
+ \vskip\spx@abovecaptionskip
+ \def\sphinxVerbatim@Before
+ {\sphinxVerbatim@Title\nointerlineskip
+ \kern\dimexpr-\dp\strutbox+\sphinxbelowcaptionspace\relax}%
+ \else
+ \vskip\sphinxverbatimsmallskipamount
+ \def\sphinxVerbatim@After
+ {\nointerlineskip\kern\dp\strutbox\sphinxVerbatim@Title}%
+ \fi
+ \def\@captype{literalblock}%
+ \capstart
+ % \sphinxVerbatimTitle must reset color
+ \setbox\sphinxVerbatim@TitleBox
+ \hbox{\begin{minipage}{\linewidth}%
+ \sphinxVerbatimTitle
+ \end{minipage}}%
+ \fi
+ \global\let\sphinxLiteralBlockLabel\empty
+ \global\let\sphinxVerbatimTitle\empty
+ \fboxsep\sphinxverbatimsep \fboxrule\sphinxverbatimborder
+ \ifspx@opt@verbatimwithframe\else\fboxrule\z@\fi
+ \let\FrameCommand \sphinxVerbatim@FrameCommand
+ \let\FirstFrameCommand\sphinxVerbatim@FirstFrameCommand
+ \let\MidFrameCommand \sphinxVerbatim@MidFrameCommand
+ \let\LastFrameCommand \sphinxVerbatim@LastFrameCommand
+ \ifspx@opt@verbatimhintsturnover\else
+ \let\sphinxVerbatim@Continued\@empty
+ \let\sphinxVerbatim@Continues\@empty
\fi
- % non-empty \sphinxVerbatimTitle has label inside it (in case there is one)
- % Customize framed.sty \MakeFramed to glue caption to literal block
- \global\spx@myfirstframedpasstrue
- % via \spx@fcolorbox, will use \spx@VerbatimFBox which inserts title
- \def\FrameCommand {\spx@colorbox\spx@fcolorbox }%
- \let\FirstFrameCommand\FrameCommand
- % for mid pages and last page portion of (long) split frame:
- \def\MidFrameCommand{\spx@colorbox\fcolorbox }%
- \let\LastFrameCommand\MidFrameCommand
+ \ifspx@opt@verbatimwrapslines
% fancyvrb's Verbatim puts each input line in (unbreakable) horizontal boxes.
% This customization wraps each line from the input in a \vtop, thus
% allowing it to wrap and display on two or more lines in the latex output.
@@ -345,68 +1061,154 @@
% to achieve this without extensive rewrite of fancyvrb.
% - The (not used in sphinx) obeytabs option to Verbatim is
% broken by this change (showtabs and tabspace work).
- \sbox\sphinxcontinuationbox {\sphinxcontinuationsymbol}%
- \sbox\sphinxvisiblespacebox {\FV@SetupFont\sphinxvisiblespace}%
- \def\FancyVerbFormatLine ##1{\hsize\linewidth
- \vtop{\raggedright\hyphenpenalty\z@\exhyphenpenalty\z@
- \doublehyphendemerits\z@\finalhyphendemerits\z@
- \strut ##1\strut}%
- }%
- % If the linebreak is at a space, the latter will be displayed as visible
- % space at end of first line, and a continuation symbol starts next line.
- % Stretch/shrink are however usually zero for typewriter font.
- \def\FV@Space {%
- \nobreak\hskip\z@ plus\fontdimen3\font minus\fontdimen4\font
- \discretionary{\copy\sphinxvisiblespacebox}{\sphinxafterbreak}
- {\kern\fontdimen2\font}%
- }%
- % go around fancyvrb's check of @currenvir (for case of minipage below)
- \renewcommand*{\VerbatimEnvironment}{\gdef\FV@EnvironName{Verbatim}}%
- % go around fancyvrb's check of current list depth
- \def\@toodeep {\advance\@listdepth\@ne}%
+ \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineWrap
+ \let\FV@Space\spx@verbatim@space
% Allow breaks at special characters using \PYG... macros.
- \sphinxbreaksatspecials
+ \sphinxbreaksatspecials
+ % Breaks at punctuation characters . , ; ? ! and / (needs catcode activation)
+ \fvset{codes*=\sphinxbreaksviaactive}%
+ \else % end of conditional code for wrapping long code lines
+ \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineNoWrap
+ \fi
+ \let\FancyVerbFormatLine\sphinxFancyVerbFormatLine
+ % workaround to fancyvrb's check of \@currenvir
+ \let\VerbatimEnvironment\sphinxVerbatimEnvironment
+ % workaround to fancyvrb's check of current list depth
+ \def\@toodeep {\advance\@listdepth\@ne}%
% The list environment is needed to control perfectly the vertical space.
% Note: \OuterFrameSep used by framed.sty is later set to \topsep hence 0pt.
- % - if caption: vertical space above caption = (\abovecaptionskip + D) with
- % D = \baselineskip-\FrameHeightAdjust, and then \smallskip above frame.
- % - if no caption: (\smallskip + D) above frame. By default D=6pt.
- % Use trivlist rather than list to avoid possible "too deeply nested" error.
+ % - if caption: distance from last text baseline to caption baseline is
+ % A+(B-F)+\ht\strutbox, A = \abovecaptionskip (default 10pt), B =
+ % \baselineskip, F is the framed.sty \FrameHeightAdjust macro, default 6pt.
+ % Formula valid for F < 10pt.
+ % - distance of baseline of caption to top of frame is like for tables:
+ % \sphinxbelowcaptionspace (=0.5\baselineskip)
+ % - if no caption: distance of last text baseline to code frame is S+(B-F),
+ % with S = \sphinxverbatimtopskip (=\smallskip)
+ % - and distance from bottom of frame to next text baseline is
+ % \baselineskip+\parskip.
+ % The \trivlist is used to avoid possible "too deeply nested" error.
\itemsep \z@skip
\topsep \z@skip
- \partopsep \z@skip% trivlist will set \parsep to \parskip = zero (see above)
+ \partopsep \z@skip
+ % trivlist will set \parsep to \parskip = zero
% \leftmargin will be set to zero by trivlist
\rightmargin\z@
\parindent \z@% becomes \itemindent. Default zero, but perhaps overwritten.
\trivlist\item\relax
- % use a minipage if we are already inside a framed environment
+ \ifsphinxverbatimwithminipage\spx@inframedtrue\fi
+ % use a minipage if we are already inside a framed environment
\ifspx@inframed\noindent\begin{minipage}{\linewidth}\fi
\MakeFramed {% adapted over from framed.sty's snugshade environment
- \advance\hsize-\width\@totalleftmargin\z@\linewidth\hsize
- \@setminipage }%
- \small
+ \advance\hsize-\width\@totalleftmargin\z@\linewidth\hsize\@setminipage
+ }%
% For grid placement from \strut's in \FancyVerbFormatLine
\lineskip\z@skip
- % Breaks at punctuation characters . , ; ? ! and / need catcode=\active
- % and the active comma should not be overwritten by \@noligs
- \let\verbatim@nolig@list \sphinx@verbatim@nolig@list
- \OriginalVerbatim[#1,codes*=\sphinxbreaksatpunct]%
+ % active comma should not be overwritten by \@noligs
+ \ifspx@opt@verbatimwrapslines
+ \let\verbatim@nolig@list \sphinx@verbatim@nolig@list
+ \fi
+ % will fetch its optional arguments if any
+ \OriginalVerbatim
}
-\renewcommand{\endVerbatim}{%
+{%
\endOriginalVerbatim
- \par\unskip\@minipagefalse\endMakeFramed
+ \par\unskip\@minipagefalse\endMakeFramed % from framed.sty snugshade
\ifspx@inframed\end{minipage}\fi
\endtrivlist
}
-
-% define macro to frame contents and add shadow on right and bottom
-% use public names for customizable lengths
-\newlength\sphinxshadowsep \setlength\sphinxshadowsep {5pt}
-\newlength\sphinxshadowsize \setlength\sphinxshadowsize {4pt}
-\newlength\sphinxshadowrule
-% this uses \fboxrule value at loading time of sphinx.sty (0.4pt normally)
-\setlength\sphinxshadowrule {\fboxrule}
-
+\newenvironment {sphinxVerbatimNoFrame}
+ {\spx@opt@verbatimwithframefalse
+ % needed for fancyvrb as literal code will end in \end{sphinxVerbatimNoFrame}
+ \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimNoFrame}}%
+ \begin{sphinxVerbatim}}
+ {\end{sphinxVerbatim}}
+\newenvironment {sphinxVerbatimintable}
+ {% don't use a frame if in a table cell
+ \spx@opt@verbatimwithframefalse
+ \sphinxverbatimwithminipagetrue
+ % the literal block caption uses \sphinxcaption which is wrapper of \caption,
+ % but \caption must be modified because longtable redefines it to work only
+ % for the own table caption, and tabulary has multiple passes
+ \let\caption\sphinxfigcaption
+ % reduce above caption skip
+ \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}%
+ \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimintable}}%
+ \begin{sphinxVerbatim}}
+ {\end{sphinxVerbatim}}
+
+
+%% PARSED LITERALS
+% allow long lines to wrap like they do in code-blocks
+
+% this should be kept in sync with definitions in sphinx.util.texescape
+\newcommand*\sphinxbreaksattexescapedchars{%
+ \def\do##1##2% put potential break point before character
+ {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}%
+ \do\{\{\do\textless\<\do\#\#\do\%\%\do\$\$% {, <, #, %, $
+ \def\do##1##2% put potential break point after character
+ {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}%
+ \do\_\_\do\}\}\do\textasciicircum\^\do\&\&% _, }, ^, &,
+ \do\textgreater\>\do\textasciitilde\~% >, ~
+}
+\newcommand*\sphinxbreaksviaactiveinparsedliteral{%
+ \sphinxbreaksviaactive % by default handles . , ; ? ! /
+ \do\-% we need also the hyphen character (ends up "as is" in parsed-literal)
+ \lccode`\~`\~ %
+ % update \dospecials as it is used by \url
+ % but deactivation will already have been done hence this is unneeded:
+ % \expandafter\def\expandafter\dospecials\expandafter{\dospecials
+ % \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}%
+}
+\newcommand*\sphinxbreaksatspaceinparsedliteral{%
+ \lccode`~32 \lowercase{\let~}\spx@verbatim@space\lccode`\~`\~
+}
+\newcommand*{\sphinxunactivateextras}{\let\do\@makeother
+ \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}%
+% the \catcode13=5\relax (deactivate end of input lines) is left to callers
+\newcommand*{\sphinxunactivateextrasandspace}{\catcode32=10\relax
+ \sphinxunactivateextras}%
+% now for the modified alltt environment
+\newenvironment{sphinxalltt}
+{% at start of next line to workaround Emacs/AUCTeX issue with this file
+\begin{alltt}%
+ \ifspx@opt@parsedliteralwraps
+ \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}%
+ \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}%
+ \sphinxbreaksattexescapedchars
+ \sphinxbreaksviaactiveinparsedliteral
+ \sphinxbreaksatspaceinparsedliteral
+% alltt takes care of the ' as derivative ("prime") in math mode
+ \everymath\expandafter{\the\everymath\sphinxunactivateextrasandspace
+ \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }%
+% not sure if displayed math (align,...) can end up in parsed-literal, anyway
+ \everydisplay\expandafter{\the\everydisplay
+ \catcode13=5 \sphinxunactivateextrasandspace
+ \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }%
+ \fi }
+{\end{alltt}}
+
+% Protect \href's first argument in contexts such as sphinxalltt (or
+% \sphinxcode). Sphinx uses \#, \%, \& ... always inside \sphinxhref.
+\protected\def\sphinxhref#1#2{{%
+ \sphinxunactivateextrasandspace % never do \scantokens with active space!
+ \endlinechar\m@ne\everyeof{{#2}}% keep catcode regime for #2
+ \scantokens{\href{#1}}% normalise it for #1 during \href expansion
+}}
+% Same for \url. And also \nolinkurl for coherence.
+\protected\def\sphinxurl#1{{%
+ \sphinxunactivateextrasandspace\everyeof{}% (<- precaution for \scantokens)
+ \endlinechar\m@ne\scantokens{\url{#1}}%
+}}
+\protected\def\sphinxnolinkurl#1{{%
+ \sphinxunactivateextrasandspace\everyeof{}%
+ \endlinechar\m@ne\scantokens{\nolinkurl{#1}}%
+}}
+
+
+%% TOPIC AND CONTENTS BOXES
+%
+% Again based on use of "framed.sty", this allows breakable framed boxes.
\long\def\spx@ShadowFBox#1{%
\leavevmode\begingroup
% first we frame the box #1
@@ -444,13 +1246,15 @@
\newenvironment{sphinxShadowBox}
{\def\FrameCommand {\spx@ShadowFBox }%
% configure framed.sty not to add extra vertical spacing
- \spx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
+ \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
% the \trivlist will add the vertical spacing on top and bottom which is
% typical of center environment as used in Sphinx <= 1.4.1
% the \noindent has the effet of an extra blank line on top, to
% imitate closely the layout from Sphinx <= 1.4.1; the \FrameHeightAdjust
% will put top part of frame on this baseline.
\def\FrameHeightAdjust {\baselineskip}%
+ % use package footnote to handle footnotes
+ \savenotes
\trivlist\item\noindent
% use a minipage if we are already inside a framed environment
\ifspx@inframed\begin{minipage}{\linewidth}\fi
@@ -464,9 +1268,6 @@
% itemize/enumerate are therein typeset more tightly, we want to keep
% that). We copy-paste from LaTeX source code but don't do a real minipage.
\@pboxswfalse
- % for footnotes, but Sphinx inactivates footnotes in topics
- \def\@mpfn{mpfootnote}\def\thempfn{\thempfootnote}\c@mpfootnote\z@
- \let\@footnotetext\@mpfootnotetext
\let\@listdepth\@mplistdepth \@mplistdepth\z@
\@minipagerestore
\@setminipage
@@ -474,98 +1275,69 @@
}%
{% insert the "endminipage" code
\par\unskip
- % handle (currently non existing) minipage style footnotes
- \ifvoid\@mpfootins\else
- \vskip\skip\@mpfootins\normalcolor\footnoterule\unvbox\@mpfootins
- \fi
\@minipagefalse
\endMakeFramed
\ifspx@inframed\end{minipage}\fi
\endtrivlist
+ % output the stored footnotes
+ \spewnotes
}
-% \moduleauthor{name}{email}
-\newcommand{\moduleauthor}[2]{}
-
-% \sectionauthor{name}{email}
-\newcommand{\sectionauthor}[2]{}
-
-% Augment the sectioning commands used to get our own font family in place,
-% and reset some internal data items:
-\titleformat{\section}{\Large\py@HeaderFamily}%
- {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}
-\titleformat{\subsection}{\large\py@HeaderFamily}%
- {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
-\titleformat{\subsubsection}{\py@HeaderFamily}%
- {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
-% By default paragraphs (and subsubsections) will not be numbered because
-% sphinxmanual.cls and sphinxhowto.cls set secnumdepth to 2
-\titleformat{\paragraph}{\py@HeaderFamily}%
- {\py@TitleColor\theparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
-\titleformat{\subparagraph}{\py@HeaderFamily}%
- {\py@TitleColor\thesubparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}
-
-% {fulllineitems} is the main environment for object descriptions.
+%% NOTICES AND ADMONITIONS
%
-\newcommand{\py@itemnewline}[1]{%
- \@tempdima\linewidth%
- \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
-}
-
-\newenvironment{fulllineitems}{
- \begin{list}{}{\labelwidth \leftmargin \labelsep 0pt
- \rightmargin 0pt \topsep -\parskip \partopsep \parskip
- \itemsep -\parsep
- \let\makelabel=\py@itemnewline}
-}{\end{list}}
-
-% \optional is used for ``[, arg]``, i.e. desc_optional nodes.
-\newcommand{\sphinxoptional}[1]{%
- {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
-
-\newlength{\py@argswidth}
-\newcommand{\py@sigparams}[2]{%
- \parbox[t]{\py@argswidth}{#1\sphinxcode{)}#2}}
-\newcommand{\pysigline}[1]{\item[#1]\nopagebreak}
-\newcommand{\pysiglinewithargsret}[3]{%
- \settowidth{\py@argswidth}{#1\sphinxcode{(}}%
- \addtolength{\py@argswidth}{-2\py@argswidth}%
- \addtolength{\py@argswidth}{\linewidth}%
- \item[#1\sphinxcode{(}\py@sigparams{#2}{#3}]}
-
-% Production lists
-%
-\newenvironment{productionlist}{
-% \def\sphinxoptional##1{{\Large[}##1{\Large]}}
- \def\production##1##2{\\\sphinxcode{##1}&::=&\sphinxcode{##2}}
- \def\productioncont##1{\\& &\sphinxcode{##1}}
- \parindent=2em
- \indent
- \setlength{\LTpre}{0pt}
- \setlength{\LTpost}{0pt}
- \begin{longtable}[l]{lcl}
-}{%
- \end{longtable}
-}
-
-% Notices / Admonitions
-%
-
+% Some are quite plain
+% the spx@notice@bordercolor etc are set in the sphinxadmonition environment
+\newenvironment{sphinxlightbox}{%
+ \par\allowbreak
+ \noindent{\color{spx@notice@bordercolor}%
+ \rule{\linewidth}{\spx@notice@border}}\par\nobreak
+ {\parskip\z@skip\noindent}%
+ }
+ {%
+ % counteract previous possible negative skip (French lists!):
+ % (we can't cancel that any earlier \vskip introduced a potential pagebreak)
+ \sphinxvspacefixafterfrenchlists
+ \nobreak\vbox{\noindent\kern\@totalleftmargin
+ {\color{spx@notice@bordercolor}%
+ \rule[\dimexpr.4\baselineskip-\spx@notice@border\relax]
+ {\linewidth}{\spx@notice@border}}\hss}\allowbreak
+ }% end of sphinxlightbox environment definition
+% may be renewenvironment'd by user for complete customization
+\newenvironment{sphinxnote}[1]
+ {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
+\newenvironment{sphinxhint}[1]
+ {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
+\newenvironment{sphinximportant}[1]
+ {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
+\newenvironment{sphinxtip}[1]
+ {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}
+% or just use the package options
+% these are needed for common handling by notice environment of lightbox
+% and heavybox but they are currently not used by lightbox environment
+% and there is consequently no corresponding package option
+\definecolor{sphinxnoteBgColor}{rgb}{1,1,1}
+\definecolor{sphinxhintBgColor}{rgb}{1,1,1}
+\definecolor{sphinximportantBgColor}{rgb}{1,1,1}
+\definecolor{sphinxtipBgColor}{rgb}{1,1,1}
+
+% Others get more distinction
% Code adapted from framed.sty's "snugshade" environment.
% Nesting works (inner frames do not allow page breaks).
-\newcommand{\py@heavybox}{\par
- \setlength{\FrameRule}{\p@}% 1pt
+\newenvironment{sphinxheavybox}{\par
+ \setlength{\FrameRule}{\spx@notice@border}%
\setlength{\FrameSep}{\dimexpr.6\baselineskip-\FrameRule\relax}
% configure framed.sty's parameters to obtain same vertical spacing
% as for "light" boxes. We need for this to manually insert parskip glue and
% revert a skip done by framed before the frame.
- \spx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
+ \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%
\vspace{\FrameHeightAdjust}
% copied/adapted from framed.sty's snugshade
\def\FrameCommand##1{\hskip\@totalleftmargin
- \fboxsep\FrameSep \fboxrule\FrameRule\fbox{##1}%
+ \fboxsep\FrameSep \fboxrule\FrameRule
+ \fcolorbox{spx@notice@bordercolor}{spx@notice@bgcolor}{##1}%
\hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth}%
+ \savenotes
% use a minipage if we are already inside a framed environment
\ifspx@inframed
\noindent\begin{minipage}{\linewidth}
@@ -581,84 +1353,85 @@
\advance\hsize-\width \@totalleftmargin\z@ \linewidth\hsize
% minipage initialization copied from LaTeX source code.
\@pboxswfalse
- % for footnotes
- \def\@mpfn{mpfootnote}\def\thempfn{\thempfootnote}\c@mpfootnote\z@
- \let\@footnotetext\@mpfootnotetext
\let\@listdepth\@mplistdepth \@mplistdepth\z@
\@minipagerestore
\@setminipage }%
}
-\newcommand{\py@endheavybox}{%
+ {%
\par\unskip
- % handles footnotes
- \ifvoid\@mpfootins\else
- \vskip\skip\@mpfootins\normalcolor\footnoterule\unvbox\@mpfootins
- \fi
\@minipagefalse
\endMakeFramed
\ifspx@inframed\end{minipage}\fi
+ % set footnotes at bottom of page
+ \spewnotes
% arrange for similar spacing below frame as for "light" boxes.
\vskip .4\baselineskip
- }
+ }% end of sphinxheavybox environment definition
+% may be renewenvironment'd by user for complete customization
+\newenvironment{sphinxwarning}[1]
+ {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+\newenvironment{sphinxcaution}[1]
+ {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+\newenvironment{sphinxattention}[1]
+ {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+\newenvironment{sphinxdanger}[1]
+ {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+\newenvironment{sphinxerror}[1]
+ {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}
+% or just use package options
+
+% the \colorlet of xcolor (if at all loaded) is overkill for our use case
+\newcommand{\sphinxcolorlet}[2]
+ {\expandafter\let\csname\@backslashchar color@#1\expandafter\endcsname
+ \csname\@backslashchar color@#2\endcsname }
+
+% the main dispatch for all types of notices
+\newenvironment{sphinxadmonition}[2]{% #1=type, #2=heading
+ % can't use #1 directly in definition of end part
+ \def\spx@noticetype {#1}%
+ % set parameters of heavybox/lightbox
+ \sphinxcolorlet{spx@notice@bordercolor}{sphinx#1BorderColor}%
+ \sphinxcolorlet{spx@notice@bgcolor}{sphinx#1BgColor}%
+ \spx@notice@border \dimexpr\csname spx@opt@#1border\endcsname\relax
+ % start specific environment, passing the heading as argument
+ \begin{sphinx#1}{#2}}
+ % workaround some LaTeX "feature" of \end command
+ {\edef\spx@temp{\noexpand\end{sphinx\spx@noticetype}}\spx@temp}
+
+
+%% PYTHON DOCS MACROS AND ENVIRONMENTS
+% (some macros here used by \maketitle in sphinxmanual.cls and sphinxhowto.cls)
-\newcommand{\py@lightbox}{%
- \par\allowbreak
- \noindent\rule{\linewidth}{0.5pt}\par\nobreak
- {\parskip\z@skip\noindent}%
- }
-\newcommand{\py@endlightbox}{%
- \par
- % counteract previous possible negative skip (French lists!):
- % (we can't cancel that any earlier \vskip introduced a potential pagebreak)
- \ifdim\lastskip<\z@\vskip-\lastskip\fi
- \nobreak\vbox{\noindent\kern\@totalleftmargin
- \rule[.4\baselineskip]{\linewidth}{0.5pt}\hss}\allowbreak
- }
+% \moduleauthor{name}{email}
+\newcommand{\moduleauthor}[2]{}
-% Some are quite plain:
-\newcommand{\py@noticestart@note}{\py@lightbox}
-\newcommand{\py@noticeend@note}{\py@endlightbox}
-\newcommand{\py@noticestart@hint}{\py@lightbox}
-\newcommand{\py@noticeend@hint}{\py@endlightbox}
-\newcommand{\py@noticestart@important}{\py@lightbox}
-\newcommand{\py@noticeend@important}{\py@endlightbox}
-\newcommand{\py@noticestart@tip}{\py@lightbox}
-\newcommand{\py@noticeend@tip}{\py@endlightbox}
-
-% Others gets more visible distinction:
-\newcommand{\py@noticestart@warning}{\py@heavybox}
-\newcommand{\py@noticeend@warning}{\py@endheavybox}
-\newcommand{\py@noticestart@caution}{\py@heavybox}
-\newcommand{\py@noticeend@caution}{\py@endheavybox}
-\newcommand{\py@noticestart@attention}{\py@heavybox}
-\newcommand{\py@noticeend@attention}{\py@endheavybox}
-\newcommand{\py@noticestart@danger}{\py@heavybox}
-\newcommand{\py@noticeend@danger}{\py@endheavybox}
-\newcommand{\py@noticestart@error}{\py@heavybox}
-\newcommand{\py@noticeend@error}{\py@endheavybox}
-
-\newenvironment{notice}[2]{
- \def\py@noticetype{#1}
- \csname py@noticestart@#1\endcsname
- \sphinxstrong{#2} % <- legacy code creates a space after {#2}
-}{\csname py@noticeend@\py@noticetype\endcsname}
+% \sectionauthor{name}{email}
+\newcommand{\sectionauthor}[2]{}
% Allow the release number to be specified independently of the
% \date{}. This allows the date to reflect the document's date and
% release to specify the release that is documented.
%
-\newcommand{\py@release}{}
-\newcommand{\version}{}
-\newcommand{\shortversion}{}
+\newcommand{\py@release}{\releasename\space\version}
+\newcommand{\version}{}% part of \py@release, used by title page and headers
+% \releaseinfo is used on titlepage (sphinxmanual.cls, sphinxhowto.cls)
\newcommand{\releaseinfo}{}
-\newcommand{\releasename}{Release}
-\newcommand{\release}[1]{%
- \renewcommand{\py@release}{\releasename\space\version}%
- \renewcommand{\version}{#1}}
-\newcommand{\setshortversion}[1]{%
- \renewcommand{\shortversion}{#1}}
-\newcommand{\setreleaseinfo}[1]{%
- \renewcommand{\releaseinfo}{#1}}
+\newcommand{\setreleaseinfo}[1]{\renewcommand{\releaseinfo}{#1}}
+% this is inserted via template and #1=release config variable
+\newcommand{\release}[1]{\renewcommand{\version}{#1}}
+% this is defined by template to 'releasename' latex_elements key
+\newcommand{\releasename}{}
+% Fix issue in case release and releasename deliberately left blank
+\newcommand{\sphinxheadercomma}{, }% used in fancyhdr header definition
+\newcommand{\sphinxifemptyorblank}[1]{%
+% test after one expansion of macro #1 if contents is empty or spaces
+ \if&\expandafter\@firstofone\detokenize\expandafter{#1}&%
+ \expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi}%
+\AtBeginDocument {%
+ \sphinxifemptyorblank{\releasename}
+ {\sphinxifemptyorblank{\version}{\let\sphinxheadercomma\empty}{}}
+ {}%
+}%
% Allow specification of the author's address separately from the
% author's name. This can be used to format them differently, which
@@ -667,47 +1440,67 @@
\newcommand{\py@authoraddress}{}
\newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}
-% This sets up the fancy chapter headings that make the documents look
-% at least a little better than the usual LaTeX output.
+% {fulllineitems} is the main environment for object descriptions.
%
-\spx@ifundefined{ChTitleVar}{}{
- \ChNameVar{\raggedleft\normalsize\py@HeaderFamily}
- \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily}
- \ChTitleVar{\raggedleft \textrm{\Huge\py@HeaderFamily}}
- % This creates chapter heads without the leading \vspace*{}:
- \def\@makechapterhead#1{%
- {\parindent \z@ \raggedright \normalfont
- \ifnum \c@secnumdepth >\m@ne
- \DOCH
- \fi
- \interlinepenalty\@M
- \DOTI{#1}
- }
- }
+\newcommand{\py@itemnewline}[1]{%
+ \kern\labelsep
+ \@tempdima\linewidth
+ \advance\@tempdima \labelwidth\makebox[\@tempdima][l]{#1}%
+ \kern-\labelsep
}
-% Redefine description environment so that it is usable inside fulllineitems.
+\newenvironment{fulllineitems}{%
+ \begin{list}{}{\labelwidth \leftmargin
+ \rightmargin \z@ \topsep -\parskip \partopsep \parskip
+ \itemsep -\parsep
+ \let\makelabel=\py@itemnewline}%
+}{\end{list}}
+
+% Signatures, possibly multi-line
%
-\renewcommand{\description}{%
- \list{}{\labelwidth\z@%
- \itemindent-\leftmargin%
- \labelsep5pt%
- \let\makelabel=\descriptionlabel}}
+\newlength{\py@argswidth}
+\newcommand{\py@sigparams}[2]{%
+ \parbox[t]{\py@argswidth}{#1\sphinxcode{)}#2}}
+\newcommand{\pysigline}[1]{\item[{#1}]}
+\newcommand{\pysiglinewithargsret}[3]{%
+ \settowidth{\py@argswidth}{#1\sphinxcode{(}}%
+ \addtolength{\py@argswidth}{-2\py@argswidth}%
+ \addtolength{\py@argswidth}{\linewidth}%
+ \item[{#1\sphinxcode{(}\py@sigparams{#2}{#3}}]}
+\newcommand{\pysigstartmultiline}{%
+ \def\pysigstartmultiline{\vskip\smallskipamount\parskip\z@skip\itemsep\z@skip}%
+ \edef\pysigstopmultiline
+ {\noexpand\leavevmode\parskip\the\parskip\relax\itemsep\the\itemsep\relax}%
+ \parskip\z@skip\itemsep\z@skip
+}
+
+% Production lists
+%
+\newenvironment{productionlist}{%
+% \def\sphinxoptional##1{{\Large[}##1{\Large]}}
+ \def\production##1##2{\\\sphinxcode{\sphinxupquote{##1}}&::=&\sphinxcode{\sphinxupquote{##2}}}%
+ \def\productioncont##1{\\& &\sphinxcode{\sphinxupquote{##1}}}%
+ \parindent=2em
+ \indent
+ \setlength{\LTpre}{0pt}%
+ \setlength{\LTpost}{0pt}%
+ \begin{longtable}[l]{lcl}
+}{%
+ \end{longtable}
+}
% Definition lists; requested by AMK for HOWTO documents. Probably useful
% elsewhere as well, so keep in in the general style support.
%
\newenvironment{definitions}{%
\begin{description}%
- \def\term##1{\item[##1]\mbox{}\\*[0mm]}
+ \def\term##1{\item[{##1}]\mbox{}\\*[0mm]}%
}{%
\end{description}%
}
-% Tell TeX about pathological hyphenation cases:
-\hyphenation{Base-HTTP-Re-quest-Hand-ler}
-
-
+%% FROM DOCTUTILS LATEX WRITER
+%
% The following is stuff copied from docutils' latex writer.
%
\newcommand{\optionlistlabel}[1]{\normalfont\bfseries #1 \hfill}% \bf deprecated
@@ -728,78 +1521,23 @@
{\setlength{\partopsep}{\parskip}
\addtolength{\partopsep}{\baselineskip}
\topsep0pt\itemsep0.15\baselineskip\parsep0pt
- \leftmargin#1}
+ \leftmargin#1\relax}
\raggedright}
{\end{list}}
-% Re-define \includegraphics to resize images larger than the line width
-% if the size is not specified.
-% Warning: future version of Sphinx will not modify original \includegraphics,
-% Below custom code will be direct definition of \sphinxincludegraphics, with
-% \py@Oldincludegraphics replaced by direct use of original \includegraphics.
-\let\py@Oldincludegraphics\includegraphics
-\newbox\spx@image@box
-\renewcommand*{\includegraphics}[2][\@empty]{%
- \ifx\@empty #1% attention, #1 could be bb.., bad if first after \ifx
- \setbox\spx@image@box=\hbox{\py@Oldincludegraphics{#2}}%
- \ifdim \wd\spx@image@box>\linewidth
- \py@Oldincludegraphics[width=\linewidth]{#2}%
- \else
- \leavevmode\box\spx@image@box
- \fi
- \else
- \py@Oldincludegraphics[#1]{#2}%
- \fi
-}
-% Writer will put \sphinxincludegraphics in LaTeX source, and with this,
-% documents which used their own modified \includegraphics will compile
-% as before. But see warning above.
-\newcommand*{\sphinxincludegraphics}{\includegraphics}
-
-% to make pdf with correct encoded bookmarks in Japanese
-% this should precede the hyperref package
-\ifx\kanjiskip\undefined
-% for non-Japanese: make sure bookmarks are ok also with lualatex
- \PassOptionsToPackage{pdfencoding=unicode}{hyperref}
-\else
- \usepackage{atbegshi}
- \ifx\ucs\undefined
- \ifnum 42146=\euc"A4A2
- \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}}
- \else
- \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}}
- \fi
- \else
- \AtBeginShipoutFirst{\special{pdf:tounicode UTF8-UCS2}}
- \fi
-\fi
-
-% Include hyperref last.
-\RequirePackage[colorlinks,breaklinks,
- linkcolor=InnerLinkColor,filecolor=OuterLinkColor,
- menucolor=OuterLinkColor,urlcolor=OuterLinkColor,
- citecolor=InnerLinkColor]{hyperref}
-% Fix anchor placement for figures with captions.
-% (Note: we don't use a package option here; instead, we give an explicit
-% \capstart for figures that actually have a caption.)
-\RequirePackage{hypcap}
-
-% Set up styles of URL: it should be placed after hyperref
-\urlstyle{same}
-
% From docutils.writers.latex2e
% inline markup (custom roles)
% \DUrole{#1}{#2} tries \DUrole#1{#2}
\providecommand*{\DUrole}[2]{%
- \ifcsname DUrole#1\endcsname%
- \csname DUrole#1\endcsname{#2}%
+ \ifcsname DUrole\detokenize{#1}\endcsname
+ \csname DUrole\detokenize{#1}\endcsname{#2}%
\else% backwards compatibility: try \docutilsrole#1{#2}
- \ifcsname docutilsrole#1\endcsname%
- \csname docutilsrole#1\endcsname{#2}%
- \else%
+ \ifcsname docutilsrole\detokenize{#1}\endcsname
+ \csname docutilsrole\detokenize{#1}\endcsname{#2}%
+ \else
#2%
- \fi%
- \fi%
+ \fi
+ \fi
}
\providecommand*{\DUprovidelength}[2]{%
@@ -820,98 +1558,127 @@
{\endlist}
\fi
-% From footmisc.sty: allows footnotes in titles
-\let\FN@sf@@footnote\footnote
-\def\footnote{\ifx\protect\@typeset@protect
- \expandafter\FN@sf@@footnote
- \else
- \expandafter\FN@sf@gobble@opt
- \fi
-}
-\edef\FN@sf@gobble@opt{\noexpand\protect
- \expandafter\noexpand\csname FN@sf@gobble@opt \endcsname}
-\expandafter\def\csname FN@sf@gobble@opt \endcsname{%
- \@ifnextchar[%]
- \FN@sf@gobble@twobracket
- \@gobble
-}
-\def\FN@sf@gobble@twobracket[#1]#2{}
-
-% adjust the margins for footer,
-% this works with the jsclasses only (Japanese standard document classes)
-\ifx\@jsc@uplatextrue\undefined\else
- \hypersetup{setpagesize=false}
- \setlength\footskip{2\baselineskip}
- \addtolength{\textheight}{-2\baselineskip}
-\fi
-
-% fix the double index and bibliography on the table of contents
-% in jsclasses (Japanese standard document classes)
-\ifx\@jsc@uplatextrue\undefined\else
- \renewcommand{\theindex}{
- \cleardoublepage
- \phantomsection
- \py@OldTheindex
- }
- \renewcommand{\thebibliography}[1]{
- \cleardoublepage
- \phantomsection
- \py@OldThebibliography{1}
- }
-\fi
-
-% disable \@chappos in Appendix in pTeX
-\ifx\kanjiskip\undefined\else
- \let\py@OldAppendix=\appendix
- \renewcommand{\appendix}{
- \py@OldAppendix
- \gdef\@chappos{}
- }
-\fi
+%% TEXT STYLING
+%
+% to obtain straight quotes we execute \@noligs as patched by upquote, and
+% \scantokens is needed in cases where it would be too late for the macro to
+% first set catcodes and then fetch its argument. We also make the contents
+% breakable at non-escaped . , ; ? ! / using \sphinxbreaksviaactive.
+% the macro must be protected if it ends up used in moving arguments,
+% in 'alltt' \@noligs is done already, and the \scantokens must be avoided.
+\protected\def\sphinxupquote#1{{\def\@tempa{alltt}%
+ \ifx\@tempa\@currenvir\else
+ \ifspx@opt@inlineliteralwraps
+ \sphinxbreaksviaactive\let\sphinxafterbreak\empty
+ % do not overwrite the comma set-up
+ \let\verbatim@nolig@list\sphinx@literal@nolig@list
+ \fi
+ % fix a space-gobbling issue due to LaTeX's original \do@noligs
+ \let\do@noligs\sphinx@do@noligs
+ \@noligs\endlinechar\m@ne\everyeof{}% (<- in case inside \sphinxhref)
+ \expandafter\scantokens
+ \fi {{#1}}}}% extra brace pair to fix end-space gobbling issue...
+\def\sphinx@do@noligs #1{\catcode`#1\active\begingroup\lccode`\~`#1\relax
+ \lowercase{\endgroup\def~{\leavevmode\kern\z@\char`#1 }}}
+\def\sphinx@literal@nolig@list {\do\`\do\<\do\>\do\'\do\-}%
-% Define literal-block environment
-\RequirePackage{newfloat}
-\DeclareFloatingEnvironment{literal-block}
-\spx@ifundefined{c@chapter}
- {\SetupFloatingEnvironment{literal-block}{within=section,placement=h}}
- {\SetupFloatingEnvironment{literal-block}{within=chapter,placement=h}}
-\SetupFloatingEnvironment{literal-block}{name=List}
-% control caption around literal-block
-\RequirePackage{capt-of}
-\RequirePackage{needspace}
-% if the left page space is less than \literalblockneedspace, insert page-break
-\newcommand{\sphinxliteralblockneedspace}{5\baselineskip}
-\newcommand{\sphinxliteralblockwithoutcaptionneedspace}{1.5\baselineskip}
+% Some custom font markup commands.
+\protected\def\sphinxstrong#1{\textbf{#1}}
+\protected\def\sphinxcode#1{\texttt{#1}}
+\protected\def\sphinxbfcode#1{\textbf{\sphinxcode{#1}}}
+\protected\def\sphinxemail#1{\textsf{#1}}
+\protected\def\sphinxtablecontinued#1{\textsf{#1}}
+\protected\def\sphinxtitleref#1{\emph{#1}}
+\protected\def\sphinxmenuselection#1{\emph{#1}}
+\protected\def\sphinxguilabel#1{\emph{#1}}
+\protected\def\sphinxaccelerator#1{\underline{#1}}
+\protected\def\sphinxcrossref#1{\emph{#1}}
+\protected\def\sphinxtermref#1{\emph{#1}}
+% \optional is used for ``[, arg]``, i.e. desc_optional nodes.
+\long\protected\def\sphinxoptional#1{%
+ {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
-% figure in table
-\newenvironment{sphinxfigure-in-table}[1][\linewidth]{%
- \def\@captype{figure}%
- \begin{minipage}{#1}%
-}{\end{minipage}}
-% store original \caption macro for use with figures in longtable and tabulary
-\AtBeginDocument{\let\spx@originalcaption\caption}
-\newcommand*\sphinxfigcaption
- {\ifx\equation$%$% this is trick to identify tabulary first pass
- \firstchoice@false\else\firstchoice@true\fi
- \spx@originalcaption }
+% additional customizable styling
+\def\sphinxstyleindexentry #1{\texttt{#1}}
+\def\sphinxstyleindexextra #1{ \emph{(#1)}}
+\def\sphinxstyleindexpageref #1{, \pageref{#1}}
+\def\sphinxstyleindexlettergroup #1%
+ {{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
+\def\sphinxstyleindexlettergroupDefault #1%
+ {{\Large\sffamily\sphinxnonalphabeticalgroupname}\nopagebreak\vspace{1mm}}
+\protected\def\sphinxstyletopictitle #1{\textbf{#1}\par\medskip}
+\let\sphinxstylesidebartitle\sphinxstyletopictitle
+\protected\def\sphinxstyleothertitle #1{\textbf{#1}}
+\protected\def\sphinxstylesidebarsubtitle #1{~\\\textbf{#1} \smallskip}
+% \text.. commands do not allow multiple paragraphs
+\protected\def\sphinxstyletheadfamily {\sffamily}
+\protected\def\sphinxstyleemphasis #1{\emph{#1}}
+\protected\def\sphinxstyleliteralemphasis#1{\emph{\sphinxcode{#1}}}
+\protected\def\sphinxstylestrong #1{\textbf{#1}}
+\protected\def\sphinxstyleliteralstrong#1{\sphinxbfcode{#1}}
+\protected\def\sphinxstyleabbreviation #1{\textsc{#1}}
+\protected\def\sphinxstyleliteralintitle#1{\sphinxcode{#1}}
+\newcommand*\sphinxstylecodecontinued[1]{\footnotesize(#1)}%
+\newcommand*\sphinxstylecodecontinues[1]{\footnotesize(#1)}%
+% figure legend comes after caption and may contain arbitrary body elements
+\newenvironment{sphinxlegend}{\par\small}{\par}
+% reduce hyperref "Token not allowed in a PDF string" warnings on PDF builds
+\AtBeginDocument{\pdfstringdefDisableCommands{%
+% all "protected" macros possibly ending up in section titles should be here
+ \let\sphinxstyleemphasis \@firstofone
+ \let\sphinxstyleliteralemphasis \@firstofone
+ \let\sphinxstylestrong \@firstofone
+ \let\sphinxstyleliteralstrong \@firstofone
+ \let\sphinxstyleabbreviation \@firstofone
+ \let\sphinxstyleliteralintitle \@firstofone
+ \let\sphinxupquote \@firstofone
+ \let\sphinxstrong \@firstofone
+ \let\sphinxcode \@firstofone
+ \let\sphinxbfcode \@firstofone
+ \let\sphinxemail \@firstofone
+ \let\sphinxcrossref \@firstofone
+ \let\sphinxtermref \@firstofone
+}}
+
+% For curly braces inside \index macro
+\def\sphinxleftcurlybrace{\{}
+\def\sphinxrightcurlybrace{\}}
+
+% Declare Unicode characters used by linux tree command to pdflatex utf8/utf8x
+\def\spx@bd#1#2{%
+ \leavevmode
+ \begingroup
+ \ifx\spx@bd@height \@undefined\def\spx@bd@height{\baselineskip}\fi
+ \ifx\spx@bd@width \@undefined\setbox0\hbox{0}\def\spx@bd@width{\wd0 }\fi
+ \ifx\spx@bd@thickness\@undefined\def\spx@bd@thickness{.6\p@}\fi
+ \ifx\spx@bd@lower \@undefined\def\spx@bd@lower{\dp\strutbox}\fi
+ \lower\spx@bd@lower#1{#2}%
+ \endgroup
+}%
+\@namedef{sphinx@u2500}% BOX DRAWINGS LIGHT HORIZONTAL
+ {\spx@bd{\vbox to\spx@bd@height}
+ {\vss\hrule\@height\spx@bd@thickness
+ \@width\spx@bd@width\vss}}%
+\@namedef{sphinx@u2502}% BOX DRAWINGS LIGHT VERTICAL
+ {\spx@bd{\hb@xt@\spx@bd@width}
+ {\hss\vrule\@height\spx@bd@height
+ \@width \spx@bd@thickness\hss}}%
+\@namedef{sphinx@u2514}% BOX DRAWINGS LIGHT UP AND RIGHT
+ {\spx@bd{\hb@xt@\spx@bd@width}
+ {\hss\raise.5\spx@bd@height
+ \hb@xt@\z@{\hss\vrule\@height.5\spx@bd@height
+ \@width \spx@bd@thickness\hss}%
+ \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness
+ \@width.5\spx@bd@width\vss}}}%
+\@namedef{sphinx@u251C}% BOX DRAWINGS LIGHT VERTICAL AND RIGHT
+ {\spx@bd{\hb@xt@\spx@bd@width}
+ {\hss
+ \hb@xt@\z@{\hss\vrule\@height\spx@bd@height
+ \@width \spx@bd@thickness\hss}%
+ \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness
+ \@width.5\spx@bd@width\vss}}}%
+\protected\def\sphinxunichar#1{\@nameuse{sphinx@u#1}}%
-% by default, also define macros with the no-prefix names
-\ifsphinxKeepOldNames
- \typeout{** (sphinx) defining (legacy) text style macros without \string\sphinx\space prefix}
- \typeout{** if clashes with packages, set latex_keep_old_macro_names=False in conf.py}
- \@for\@tempa:=strong,bfcode,email,tablecontinued,titleref,%
- menuselection,accelerator,crossref,termref,optional\do
-{% first, check if command with no prefix already exists
- \expandafter\newcommand\csname\@tempa\endcsname{}%
- % if no error give it the meaning defined so far with \sphinx prefix
- \expandafter\let\csname\@tempa\expandafter\endcsname
- \csname sphinx\@tempa\endcsname
- % redefine the \sphinx prefixed macro to expand to non-prefixed one
- \expandafter\def\csname sphinx\@tempa\expandafter\endcsname
- \expandafter{\csname\@tempa\endcsname}%
-}
- % robustified case needs special treatment
- \newcommand\code{}\let\code\relax
- \DeclareRobustCommand{\code}[1]{{\@noligs\scantokens{\texttt{#1}\relax}}}
- \def\sphinxcode{\code}%
-\fi
+% Tell TeX about pathological hyphenation cases:
+\hyphenation{Base-HTTP-Re-quest-Hand-ler}
+\endinput
diff --git a/doc/latex/sphinxhighlight.sty b/doc/latex/sphinxhighlight.sty
index b1d6bd0..ad7c3db 100644
--- a/doc/latex/sphinxhighlight.sty
+++ b/doc/latex/sphinxhighlight.sty
@@ -13,73 +13,73 @@
\PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}}
\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}}
-\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.40,0.60}{##1}}}
-\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.67,0.67}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@sa\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit}
-\expandafter\def\csname PYG@tok@mb\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.40,0.00,0.93}{##1}}}
-\expandafter\def\csname PYG@tok@c1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@ne\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.73}{##1}}}
+\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}}
\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
+\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}}
\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.80}{##1}}}
-\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}}
+\expandafter\def\csname PYG@tok@ch\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
+\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.60,0.47,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.53,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
\expandafter\def\csname PYG@tok@c\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}}
\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}}
-\expandafter\def\csname PYG@tok@ch\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
+\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}}
\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf}
-\expandafter\def\csname PYG@tok@cs\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.80,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}}
\expandafter\def\csname PYG@tok@kp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.20,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.33,0.47,0.60}{##1}}}
-\expandafter\def\csname PYG@tok@dl\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
-\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
\expandafter\def\csname PYG@tok@mf\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.40,0.00,0.93}{##1}}}
-\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.60,0.40,0.20}{##1}}}
+\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.40,0.60}{##1}}}
+\expandafter\def\csname PYG@tok@no\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.20,0.40}{##1}}}
+\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
+\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
+\expandafter\def\csname PYG@tok@c1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
+\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit}
+\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.00}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,1.00}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@kt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.60}{##1}}}
+\expandafter\def\csname PYG@tok@si\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{0.93,0.93,0.93}{\strut ##1}}}
\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@cm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.87,0.13,0.00}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@cs\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.80,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@mh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.33,0.53}{##1}}}
+\expandafter\def\csname PYG@tok@sa\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\expandafter\def\csname PYG@tok@mi\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.87}{##1}}}
+\expandafter\def\csname PYG@tok@sd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.87,0.27,0.13}{##1}}}
\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.87,0.13,0.00}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}}
+\expandafter\def\csname PYG@tok@cm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
+\expandafter\def\csname PYG@tok@dl\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@vm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.60,0.40,0.20}{##1}}}
+\expandafter\def\csname PYG@tok@mb\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.40,0.00,0.93}{##1}}}
+\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@cpf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
+\expandafter\def\csname PYG@tok@vg\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.87,0.47,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@ne\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}}
+\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
\expandafter\def\csname PYG@tok@il\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.87}{##1}}}
-\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
-\expandafter\def\csname PYG@tok@mo\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.27,0.00,0.93}{##1}}}
+\expandafter\def\csname PYG@tok@nt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.47,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.73,0.00,0.40}{##1}}}
\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
+\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.67,0.67}{\strut ##1}}}
\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.67,0.40,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}}
-\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@nf\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.40,0.73}{##1}}}
-\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.60,0.47,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@si\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{0.93,0.93,0.93}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.00}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,1.00}{\strut ##1}}}
-\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
+\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.60,0.40,0.20}{##1}}}
\expandafter\def\csname PYG@tok@m\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.40,0.00,0.93}{##1}}}
+\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
\expandafter\def\csname PYG@tok@fm\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.40,0.73}{##1}}}
-\expandafter\def\csname PYG@tok@sd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.87,0.27,0.13}{##1}}}
+\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.33,0.47,0.60}{##1}}}
\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@mh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.33,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
-\expandafter\def\csname PYG@tok@no\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.20,0.40}{##1}}}
-\expandafter\def\csname PYG@tok@nt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.47,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@kt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.60}{##1}}}
-\expandafter\def\csname PYG@tok@vg\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.87,0.47,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.73,0.00,0.40}{##1}}}
-\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.53,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@mi\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.87}{##1}}}
-\expandafter\def\csname PYG@tok@cpf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.53,0.53,0.53}{##1}}}
-\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}}
-\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.73}{##1}}}
-\expandafter\def\csname PYG@tok@vm\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.60,0.40,0.20}{##1}}}
-\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.00}{##1}}}
-\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
+\expandafter\def\csname PYG@tok@nf\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.40,0.73}{##1}}}
+\expandafter\def\csname PYG@tok@mo\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.27,0.00,0.93}{##1}}}
\def\PYGZbs{\char`\\}
\def\PYGZus{\char`\_}
diff --git a/doc/latex/sphinxhowto.cls b/doc/latex/sphinxhowto.cls
index 8d5c592..8b0530a 100644
--- a/doc/latex/sphinxhowto.cls
+++ b/doc/latex/sphinxhowto.cls
@@ -3,13 +3,7 @@
%
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
-\ProvidesClass{sphinxhowto}[2009/06/02 Document class (Sphinx HOWTO)]
-
-\ifx\directlua\undefined\else
-% if compiling with lualatex 0.85 or later load compatibility patch issued by
-% the LaTeX team for older packages relying on \pdf<name> named primitives.
- \IfFileExists{luatex85.sty}{\RequirePackage{luatex85}}{}
-\fi
+\ProvidesClass{sphinxhowto}[2017/03/26 v1.6 Document class (Sphinx HOWTO)]
% 'oneside' option overriding the 'twoside' default
\newif\if@oneside
@@ -31,25 +25,18 @@
% reset these counters in your preamble.
%
\setcounter{secnumdepth}{2}
+\setcounter{tocdepth}{2}% i.e. section and subsection
% Change the title page to look a bit better, and fit in with the fncychap
% ``Bjarne'' style a bit better.
%
\renewcommand{\maketitle}{%
- \noindent\rule{\textwidth}{1pt}\ifsphinxpdfoutput\newline\null\fi\par
- \ifsphinxpdfoutput
- \begingroup
- % These \defs are required to deal with multi-line authors; it
- % changes \\ to ', ' (comma-space), making it pass muster for
- % generating document info in the PDF file.
- \def\\{, }%
- \def\and{and }%
- \pdfinfo{
- /Author (\@author)
- /Title (\@title)
- }%
+ \noindent\rule{\textwidth}{1pt}\par
+ \begingroup % for PDF information dictionary
+ \def\endgraf{ }\def\and{\& }%
+ \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup
+ \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}%
\endgroup
- \fi
\begin{flushright}
\sphinxlogo
\py@HeaderFamily
@@ -70,11 +57,10 @@
%\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
}
-\let\py@OldTableofcontents=\tableofcontents
-\renewcommand{\tableofcontents}{
+\newcommand{\sphinxtableofcontents}{
\begingroup
\parskip = 0mm
- \py@OldTableofcontents
+ \tableofcontents
\endgroup
\rule{\textwidth}{1pt}
\vspace{12pt}
@@ -91,21 +77,19 @@
% Contents.
% For an article document class this environment is a section,
% so no page break before it.
-\let\py@OldThebibliography=\thebibliography
-\renewcommand{\thebibliography}[1]{
- \phantomsection
- \py@OldThebibliography{1}
- \addcontentsline{toc}{section}{\bibname}
-}
+%
+\newenvironment{sphinxthebibliography}[1]{%
+ % \phantomsection % not needed here since TeXLive 2010's hyperref
+ \begin{thebibliography}{#1}%
+ \addcontentsline{toc}{section}{\ifdefined\refname\refname\else\ifdefined\bibname\bibname\fi\fi}}{\end{thebibliography}}
+
% Same for the indices.
% The memoir class already does this, so we don't duplicate it in that case.
%
-\@ifclassloaded{memoir}{}{
- \let\py@OldTheindex=\theindex
- \renewcommand{\theindex}{
- \phantomsection
- \py@OldTheindex
- \addcontentsline{toc}{section}{\indexname}
- }
-}
+\@ifclassloaded{memoir}
+ {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}
+ {\newenvironment{sphinxtheindex}{%
+ \phantomsection % needed because no chapter, section, ... is created by theindex
+ \begin{theindex}%
+ \addcontentsline{toc}{section}{\indexname}}{\end{theindex}}}
diff --git a/doc/latex/sphinxmanual.cls b/doc/latex/sphinxmanual.cls
index f204494..94c71d7 100644
--- a/doc/latex/sphinxmanual.cls
+++ b/doc/latex/sphinxmanual.cls
@@ -3,13 +3,7 @@
%
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
-\ProvidesClass{sphinxmanual}[2009/06/02 Document class (Sphinx manual)]
-
-\ifx\directlua\undefined\else
-% if compiling with lualatex 0.85 or later load compatibility patch issued by
-% the LaTeX team for older packages relying on \pdf<name> named primitives.
- \IfFileExists{luatex85.sty}{\RequirePackage{luatex85}}{}
-\fi
+\ProvidesClass{sphinxmanual}[2017/03/26 v1.6 Document class (Sphinx manual)]
% chapters starting at odd pages (overridden by 'openany' document option)
\PassOptionsToClass{openright}{\sphinxdocclass}
@@ -40,23 +34,18 @@
% ``Bjarne'' style a bit better.
%
\renewcommand{\maketitle}{%
+ \let\spx@tempa\relax
+ \ifHy@pageanchor\def\spx@tempa{\Hy@pageanchortrue}\fi
+ \hypersetup{pageanchor=false}% avoid duplicate destination warnings
\begin{titlepage}%
\let\footnotesize\small
\let\footnoterule\relax
- \noindent\rule{\textwidth}{1pt}\ifsphinxpdfoutput\newline\null\fi\par
- \ifsphinxpdfoutput
- \begingroup
- % These \defs are required to deal with multi-line authors; it
- % changes \\ to ', ' (comma-space), making it pass muster for
- % generating document info in the PDF file.
- \def\\{, }%
- \def\and{and }%
- \pdfinfo{
- /Author (\@author)
- /Title (\@title)
- }%
+ \noindent\rule{\textwidth}{1pt}\par
+ \begingroup % for PDF information dictionary
+ \def\endgraf{ }\def\and{\& }%
+ \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup
+ \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}%
\endgroup
- \fi
\begin{flushright}%
\sphinxlogo
\py@HeaderFamily
@@ -80,24 +69,22 @@
\setcounter{footnote}{0}%
\let\thanks\relax\let\maketitle\relax
%\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
+ \if@openright\cleardoublepage\else\clearpage\fi
+ \spx@tempa
}
-\let\py@OldTableofcontents=\tableofcontents
-\renewcommand{\tableofcontents}{%
- % before resetting page counter, let's do the right thing.
- \if@openright\cleardoublepage\else\clearpage\fi
+\newcommand{\sphinxtableofcontents}{%
\pagenumbering{roman}%
\pagestyle{plain}%
\begingroup
\parskip \z@skip
- \py@OldTableofcontents
+ \tableofcontents
\endgroup
% before resetting page counter, let's do the right thing.
\if@openright\cleardoublepage\else\clearpage\fi
\pagenumbering{arabic}%
\ifdefined\fancyhf\pagestyle{normal}\fi
}
-\pagenumbering{alph}% avoid hyperref "duplicate destination" warnings
% This is needed to get the width of the section # area wide enough in the
% library reference. Doing it here keeps it the same for all the manuals.
@@ -108,23 +95,20 @@
% Fix the bibliography environment to add an entry to the Table of
% Contents.
% For a report document class this environment is a chapter.
-\let\py@OldThebibliography=\thebibliography
-\renewcommand{\thebibliography}[1]{
+%
+\newenvironment{sphinxthebibliography}[1]{%
\if@openright\cleardoublepage\else\clearpage\fi
- \phantomsection
- \py@OldThebibliography{1}
- \addcontentsline{toc}{chapter}{\bibname}
-}
+ % \phantomsection % not needed here since TeXLive 2010's hyperref
+ \begin{thebibliography}{#1}%
+ \addcontentsline{toc}{chapter}{\bibname}}{\end{thebibliography}}
% Same for the indices.
% The memoir class already does this, so we don't duplicate it in that case.
%
-\@ifclassloaded{memoir}{}{
- \let\py@OldTheindex=\theindex
- \renewcommand{\theindex}{
+\@ifclassloaded{memoir}
+ {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}
+ {\newenvironment{sphinxtheindex}{%
\if@openright\cleardoublepage\else\clearpage\fi
- \phantomsection
- \py@OldTheindex
- \addcontentsline{toc}{chapter}{\indexname}
- }
-}
+ \phantomsection % needed as no chapter, section, ... created
+ \begin{theindex}%
+ \addcontentsline{toc}{chapter}{\indexname}}{\end{theindex}}}
diff --git a/doc/latex/tabulary.sty b/doc/latex/tabulary.sty
deleted file mode 100644
index 11fdf74..0000000
--- a/doc/latex/tabulary.sty
+++ /dev/null
@@ -1,452 +0,0 @@
-%%
-%% This is file `tabulary.sty',
-%% generated with the docstrip utility.
-%%
-%% The original source files were:
-%%
-%% tabulary.dtx (with options: `package')
-%% DRAFT VERSION
-%%
-%% File `tabulary.dtx'.
-%% Copyright (C) 1995 1996 2003 2008 David Carlisle
-%% This file may be distributed under the terms of the LPPL.
-%% See 00readme.txt for details.
-%%
-\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{tabulary}
- [2008/12/01 v0.9 tabulary package (DPC)]
-\RequirePackage{array}
-\catcode`\Z=14
-\DeclareOption{debugshow}{\catcode`\Z=9\relax}
-\ProcessOptions
-\def\arraybackslash{\let\\=\@arraycr}
-\def\@finalstrut#1{%
- \unskip\ifhmode\nobreak\fi\vrule\@width\z@\@height\z@\@depth\dp#1}
-\newcount\TY@count
-\def\tabulary{%
- \let\TY@final\tabular
- \let\endTY@final\endtabular
- \TY@tabular}
-\def\TY@tabular#1{%
- \edef\TY@{\@currenvir}%
- {\ifnum0=`}\fi
- \@ovxx\TY@linewidth
- \@ovyy\TY@tablewidth
- \count@\z@
- \@tempswatrue
- \@whilesw\if@tempswa\fi{%
- \advance\count@\@ne
- \expandafter\ifx\csname TY@F\the\count@\endcsname\relax
- \@tempswafalse
- \else
- \expandafter\let\csname TY@SF\the\count@\expandafter\endcsname
- \csname TY@F\the\count@\endcsname
- \global\expandafter\let\csname TY@F\the\count@\endcsname\relax
- \expandafter\let\csname TY@S\the\count@\expandafter\endcsname
- \csname TY@\the\count@\endcsname
- \fi}%
- \global\TY@count\@ne
- \TY@width\xdef{0pt}%
- \global\TY@tablewidth\z@
- \global\TY@linewidth#1\relax
-Z\message{^^J^^JTable^^J%
-Z Target Width: \the\TY@linewidth^^J%
-Z \string\tabcolsep: \the\tabcolsep\space
-Z \string\arrayrulewidth: \the\arrayrulewidth\space
-Z \string\doublerulesep: \the\doublerulesep^^J%
-Z \string\tymin: \the\tymin\space
-Z \string\tymax: \the\tymax^^J}%
- \let\@classz\TY@classz
- \let\verb\TX@verb
- \toks@{}\TY@get@body}
-\let\TY@@mkpream\@mkpream
-\def\TY@mkpream{%
- \def\@addamp{%
- \if@firstamp \@firstampfalse \else
- \global\advance\TY@count\@ne
- \edef\@preamble{\@preamble &}\fi
- \TY@width\xdef{0pt}}%
- \def\@acol{%
- \TY@subwidth\col@sep
- \@addtopreamble{\hskip\col@sep}}%
- \let\@arrayrule\TY@arrayrule
- \let\@classvi\TY@classvi
- \def\@classv{\save@decl
- \expandafter\NC@ecs\@nextchar\extracolsep{}\extracolsep\@@@
- \sbox\z@{\d@llarbegin\@nextchar\d@llarend}%
- \TY@subwidth{\wd\z@}%
- \@addtopreamble{\d@llarbegin\the@toks\the\count@\relax\d@llarend}%
- \prepnext@tok}%
- \global\let\@mkpream\TY@@mkpream
- \TY@@mkpream}
-\def\TY@arrayrule{%
- \TY@subwidth\arrayrulewidth
- \@addtopreamble \vline}
-\def\TY@classvi{\ifcase \@lastchclass
- \@acol \or
- \TY@subwidth\doublerulesep
- \@addtopreamble{\hskip \doublerulesep}\or
- \@acol \or
- \@classvii
- \fi}
-\def\TY@tab{%
- \setbox\z@\hbox\bgroup
- \let\[$\let\]$%
- \let\equation$\let\endequation$%
- \col@sep\tabcolsep
- \let\d@llarbegin\begingroup\let\d@llarend\endgroup
- \let\@mkpream\TY@mkpream
- \def\multicolumn##1##2##3{\multispan##1\relax}%
- \CT@start\TY@tabarray}
-\def\TY@tabarray{\@ifnextchar[{\TY@array}{\@array[t]}}
-\def\TY@array[#1]{\@array[t]}
-\def\TY@width#1{%
- \expandafter#1\csname TY@\the\TY@count\endcsname}
-\def\TY@subwidth#1{%
- \TY@width\dimen@
- \advance\dimen@-#1\relax
- \TY@width\xdef{\the\dimen@}%
- \global\advance\TY@linewidth-#1\relax}
-\def\endtabulary{%
- \gdef\@halignto{}%
- \let\TY@footnote\footnote%
- \def\footnote{}% prevent footnotes from doing anything
- \expandafter\TY@tab\the\toks@
- \crcr\omit
- {\xdef\TY@save@row{}%
- \loop
- \advance\TY@count\m@ne
- \ifnum\TY@count>\z@
- \xdef\TY@save@row{\TY@save@row&\omit}%
- \repeat}\TY@save@row
- \endarray\global\setbox1=\lastbox\setbox0=\vbox{\unvbox1
- \unskip\global\setbox1=\lastbox}\egroup
- \dimen@\TY@linewidth
- \divide\dimen@\TY@count
- \ifdim\dimen@<\tymin
- \TY@warn{tymin too large (\the\tymin), resetting to \the\dimen@}%
- \tymin\dimen@
- \fi
- \setbox\tw@=\hbox{\unhbox\@ne
- \loop
-\@tempdima=\lastskip
-\ifdim\@tempdima>\z@
-Z \message{ecs=\the\@tempdima^^J}%
- \global\advance\TY@linewidth-\@tempdima
-\fi
- \unskip
- \setbox\tw@=\lastbox
- \ifhbox\tw@
-Z \message{Col \the\TY@count: Initial=\the\wd\tw@\space}%
- \ifdim\wd\tw@>\tymax
- \wd\tw@\tymax
-Z \message{> max\space}%
-Z \else
-Z \message{ \@spaces\space}%
- \fi
- \TY@width\dimen@
-Z \message{\the\dimen@\space}%
- \advance\dimen@\wd\tw@
-Z \message{Final=\the\dimen@\space}%
- \TY@width\xdef{\the\dimen@}%
- \ifdim\dimen@<\tymin
-Z \message{< tymin}%
- \global\advance\TY@linewidth-\dimen@
- \expandafter\xdef\csname TY@F\the\TY@count\endcsname
- {\the\dimen@}%
- \else
- \expandafter\ifx\csname TY@F\the\TY@count\endcsname\z@
-Z \message{***}%
- \global\advance\TY@linewidth-\dimen@
- \expandafter\xdef\csname TY@F\the\TY@count\endcsname
- {\the\dimen@}%
- \else
-Z \message{> tymin}%
- \global\advance\TY@tablewidth\dimen@
- \global\expandafter\let\csname TY@F\the\TY@count\endcsname
- \maxdimen
- \fi\fi
- \advance\TY@count\m@ne
- \repeat}%
- \TY@checkmin
- \TY@checkmin
- \TY@checkmin
- \TY@checkmin
- \TY@count\z@
- \let\TY@box\TY@box@v
- \let\footnote\TY@footnote % restore footnotes
- {\expandafter\TY@final\the\toks@\endTY@final}%
- \count@\z@
- \@tempswatrue
- \@whilesw\if@tempswa\fi{%
- \advance\count@\@ne
- \expandafter\ifx\csname TY@SF\the\count@\endcsname\relax
- \@tempswafalse
- \else
- \global\expandafter\let\csname TY@F\the\count@\expandafter\endcsname
- \csname TY@SF\the\count@\endcsname
- \global\expandafter\let\csname TY@\the\count@\expandafter\endcsname
- \csname TY@S\the\count@\endcsname
- \fi}%
- \TY@linewidth\@ovxx
- \TY@tablewidth\@ovyy
- \ifnum0=`{\fi}}
-\def\TY@checkmin{%
- \let\TY@checkmin\relax
-\ifdim\TY@tablewidth>\z@
- \Gscale@div\TY@ratio\TY@linewidth\TY@tablewidth
- \ifdim\TY@tablewidth <\TY@linewidth
- \def\TY@ratio{1}%
- \fi
-\else
- \TY@warn{No suitable columns!}%
- \def\TY@ratio{1}%
-\fi
-\count@\z@
-Z \message{^^JLine Width: \the\TY@linewidth,
-Z Natural Width: \the\TY@tablewidth,
-Z Ratio: \TY@ratio^^J}%
-\@tempdima\z@
-\loop
-\ifnum\count@<\TY@count
-\advance\count@\@ne
- \ifdim\csname TY@F\the\count@\endcsname>\tymin
- \dimen@\csname TY@\the\count@\endcsname
- \dimen@\TY@ratio\dimen@
- \ifdim\dimen@<\tymin
-Z \message{Column \the\count@\space ->}%
- \global\expandafter\let\csname TY@F\the\count@\endcsname\tymin
- \global\advance\TY@linewidth-\tymin
- \global\advance\TY@tablewidth-\csname TY@\the\count@\endcsname
- \let\TY@checkmin\TY@@checkmin
- \else
- \expandafter\xdef\csname TY@F\the\count@\endcsname{\the\dimen@}%
- \advance\@tempdima\csname TY@F\the\count@\endcsname
- \fi
- \fi
-Z \dimen@\csname TY@F\the\count@\endcsname\message{\the\dimen@, }%
-\repeat
-Z \message{^^JTotal:\the\@tempdima^^J}%
-}
-\let\TY@@checkmin\TY@checkmin
-\newdimen\TY@linewidth
-\def\tyformat{\everypar{{\nobreak\hskip\z@skip}}}
-\newdimen\tymin
-\tymin=10pt
-\newdimen\tymax
-\tymax=2\textwidth
-\def\@testpach{\@chclass
- \ifnum \@lastchclass=6 \@ne \@chnum \@ne \else
- \ifnum \@lastchclass=7 5 \else
- \ifnum \@lastchclass=8 \tw@ \else
- \ifnum \@lastchclass=9 \thr@@
- \else \z@
- \ifnum \@lastchclass = 10 \else
- \edef\@nextchar{\expandafter\string\@nextchar}%
- \@chnum
- \if \@nextchar c\z@ \else
- \if \@nextchar l\@ne \else
- \if \@nextchar r\tw@ \else
- \if \@nextchar C7 \else
- \if \@nextchar L8 \else
- \if \@nextchar R9 \else
- \if \@nextchar J10 \else
- \z@ \@chclass
- \if\@nextchar |\@ne \else
- \if \@nextchar !6 \else
- \if \@nextchar @7 \else
- \if \@nextchar <8 \else
- \if \@nextchar >9 \else
- 10
- \@chnum
- \if \@nextchar m\thr@@\else
- \if \@nextchar p4 \else
- \if \@nextchar b5 \else
- \z@ \@chclass \z@ \@preamerr \z@ \fi \fi \fi \fi\fi \fi \fi\fi \fi
- \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi}
-\def\TY@classz{%
- \@classx
- \@tempcnta\count@
- \ifx\TY@box\TY@box@v
- \global\advance\TY@count\@ne
- \fi
- \let\centering c%
- \let\raggedright\noindent
- \let\raggedleft\indent
- \let\arraybackslash\relax
- \prepnext@tok
- \ifnum\@chnum<4
- \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
- \fi
- \ifnum\@chnum=6
- \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
- \fi
- \@addtopreamble{%
- \ifcase\@chnum
- \hfil \d@llarbegin\insert@column\d@llarend \hfil \or
- \kern\z@
- \d@llarbegin \insert@column \d@llarend \hfil \or
- \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \or
- $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or
- \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or
- \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or
- \d@llarbegin \insert@column \d@llarend \or% dubious "s" case
- \TY@box\centering\or
- \TY@box\raggedright\or
- \TY@box\raggedleft\or
- \TY@box\relax
- \fi}\prepnext@tok}
-\def\TY@box#1{%
- \ifx\centering#1%
- \hfil \d@llarbegin\insert@column\d@llarend \hfil \else
- \ifx\raggedright#1%
- \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
- \d@llarbegin \insert@column \d@llarend \hfil \else
- \ifx\raggedleft#1%
- \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \else
- \ifx\relax#1%
- \d@llarbegin \insert@column \d@llarend
- \fi \fi \fi \fi}
-\def\TY@box@v#1{%
- \vtop \@startpbox{\csname TY@F\the\TY@count\endcsname}%
- #1\arraybackslash\tyformat
- \insert@column\@endpbox}
-\newdimen\TY@tablewidth
-\def\Gscale@div#1#2#3{%
- \setlength\dimen@{#3}%
- \ifdim\dimen@=\z@
- \PackageError{graphics}{Division by 0}\@eha
- \dimen@#2%
- \fi
- \edef\@tempd{\the\dimen@}%
- \setlength\dimen@{#2}%
- \count@65536\relax
- \ifdim\dimen@<\z@
- \dimen@-\dimen@
- \count@-\count@
- \fi
- \loop
- \ifdim\dimen@<8192\p@
- \dimen@\tw@\dimen@
- \divide\count@\tw@
- \repeat
- \dimen@ii=\@tempd\relax
- \divide\dimen@ii\count@
- \divide\dimen@\dimen@ii
- \edef#1{\strip@pt\dimen@}}
-\long\def\TY@get@body#1\end
- {\toks@\expandafter{\the\toks@#1}\TY@find@end}
-\def\TY@find@end#1{%
- \def\@tempa{#1}%
- \ifx\@tempa\TY@\def\@tempa{\end{#1}}\expandafter\@tempa
- \else\toks@\expandafter
- {\the\toks@\end{#1}}\expandafter\TY@get@body\fi}
-\def\TY@warn{%
- \PackageWarning{tabulary}}
-\catcode`\Z=11
-\AtBeginDocument{
-\@ifpackageloaded{colortbl}{%
-\expandafter\def\expandafter\@mkpream\expandafter#\expandafter1%
- \expandafter{%
- \expandafter\let\expandafter\CT@setup\expandafter\relax
- \expandafter\let\expandafter\CT@color\expandafter\relax
- \expandafter\let\expandafter\CT@do@color\expandafter\relax
- \expandafter\let\expandafter\color\expandafter\relax
- \expandafter\let\expandafter\CT@column@color\expandafter\relax
- \expandafter\let\expandafter\CT@row@color\expandafter\relax
- \@mkpream{#1}}
-\let\TY@@mkpream\@mkpream
-\def\TY@classz{%
- \@classx
- \@tempcnta\count@
- \ifx\TY@box\TY@box@v
- \global\advance\TY@count\@ne
- \fi
- \let\centering c%
- \let\raggedright\noindent
- \let\raggedleft\indent
- \let\arraybackslash\relax
- \prepnext@tok
-\expandafter\CT@extract\the\toks\@tempcnta\columncolor!\@nil
- \ifnum\@chnum<4
- \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
- \fi
- \ifnum\@chnum=6
- \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@
- \fi
- \@addtopreamble{%
- \setbox\z@\hbox\bgroup\bgroup
- \ifcase\@chnum
- \hskip\stretch{.5}\kern\z@
- \d@llarbegin\insert@column\d@llarend\hskip\stretch{.5}\or
- \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<<
- \d@llarbegin \insert@column \d@llarend \hfill \or
- \hfill\kern\z@ \d@llarbegin \insert@column \d@llarend \or
- $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or
- \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or
- \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or
- \d@llarbegin \insert@column \d@llarend \or% dubious s case
- \TY@box\centering\or
- \TY@box\raggedright\or
- \TY@box\raggedleft\or
- \TY@box\relax
- \fi
- \egroup\egroup
-\begingroup
- \CT@setup
- \CT@column@color
- \CT@row@color
- \CT@do@color
-\endgroup
- \@tempdima\ht\z@
- \advance\@tempdima\minrowclearance
- \vrule\@height\@tempdima\@width\z@
-\unhbox\z@
-}\prepnext@tok}%
- \def\TY@arrayrule{%
- \TY@subwidth\arrayrulewidth
- \@addtopreamble{{\CT@arc@\vline}}}%
- \def\TY@classvi{\ifcase \@lastchclass
- \@acol \or
- \TY@subwidth\doublerulesep
- \ifx\CT@drsc@\relax
- \@addtopreamble{\hskip\doublerulesep}%
- \else
- \@addtopreamble{{\CT@drsc@\vrule\@width\doublerulesep}}%
- \fi\or
- \@acol \or
- \@classvii
- \fi}%
-}{%
-\let\CT@start\relax
-}
-}
-{\uccode`\*=`\ %
-\uppercase{\gdef\TX@verb{%
- \leavevmode\null\TX@vwarn
- {\ifnum0=`}\fi\ttfamily\let\\\ignorespaces
- \@ifstar{\let~*\TX@vb}{\TX@vb}}}}
-\def\TX@vb#1{\def\@tempa##1#1{\toks@{##1}\edef\@tempa{\the\toks@}%
- \expandafter\TX@v\meaning\@tempa\\ \\\ifnum0=`{\fi}}\@tempa!}
-\def\TX@v#1!{\afterassignment\TX@vfirst\let\@tempa= }
-\begingroup
-\catcode`\*=\catcode`\#
-\catcode`\#=12
-\gdef\TX@vfirst{%
- \if\@tempa#%
- \def\@tempb{\TX@v@#}%
- \else
- \let\@tempb\TX@v@
- \if\@tempa\space~\else\@tempa\fi
- \fi
- \@tempb}
-\gdef\TX@v@*1 *2{%
- \TX@v@hash*1##\relax\if*2\\\else~\expandafter\TX@v@\fi*2}
-\gdef\TX@v@hash*1##*2{*1\ifx*2\relax\else#\expandafter\TX@v@hash\fi*2}
-\endgroup
-\def\TX@vwarn{%
- \@warning{\noexpand\verb may be unreliable inside tabularx/y}%
- \global\let\TX@vwarn\@empty}
-\endinput
-%%
-%% End of file `tabulary.sty'.
diff --git a/doc/man/fsck.s3ql.1 b/doc/man/fsck.s3ql.1
index 3c5e854..bc32d5a 100644
--- a/doc/man/fsck.s3ql.1
+++ b/doc/man/fsck.s3ql.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "FSCK.S3QL" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "FSCK.S3QL" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
fsck.s3ql \- Check an S3QL file system for errors
.
@@ -192,7 +192,7 @@ corrected or not).
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/mkfs.s3ql.1 b/doc/man/mkfs.s3ql.1
index 63add5d..047a1b6 100644
--- a/doc/man/mkfs.s3ql.1
+++ b/doc/man/mkfs.s3ql.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "MKFS.S3QL" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "MKFS.S3QL" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
mkfs.s3ql \- Create an S3QL file system
.
@@ -152,7 +152,7 @@ Unable to access cache directory.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/mount.s3ql.1 b/doc/man/mount.s3ql.1
index 0eb5be5..4f12d0e 100644
--- a/doc/man/mount.s3ql.1
+++ b/doc/man/mount.s3ql.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "MOUNT.S3QL" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "MOUNT.S3QL" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
mount.s3ql \- Mount an S3QL file system
.
@@ -230,7 +230,7 @@ Unable to access cache directory.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/s3ql_oauth_client.1 b/doc/man/s3ql_oauth_client.1
index 49d1121..5107f99 100644
--- a/doc/man/s3ql_oauth_client.1
+++ b/doc/man/s3ql_oauth_client.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "S3QL_OAUTH_CLIENT" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "S3QL_OAUTH_CLIENT" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
s3ql_oauth_client \- Obtain Google Storage OAuth2 tokens
.
@@ -100,7 +100,7 @@ Invalid command line argument or configuration file key.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/s3ql_verify.1 b/doc/man/s3ql_verify.1
index 2dbdcfc..0eb63eb 100644
--- a/doc/man/s3ql_verify.1
+++ b/doc/man/s3ql_verify.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "S3QL_VERIFY" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "S3QL_VERIFY" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
s3ql_verify \- Verify data in an S3QL file system
.
@@ -173,7 +173,7 @@ to be missing or corrupted.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/s3qladm.1 b/doc/man/s3qladm.1
index b724b0c..e1d5db4 100644
--- a/doc/man/s3qladm.1
+++ b/doc/man/s3qladm.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "S3QLADM" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "S3QLADM" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
s3qladm \- Manage S3QL file systems
.
@@ -175,7 +175,7 @@ Unable to access cache directory.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/s3qlcp.1 b/doc/man/s3qlcp.1
index d6c0831..cabec0d 100644
--- a/doc/man/s3qlcp.1
+++ b/doc/man/s3qlcp.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "S3QLCP" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "S3QLCP" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
s3qlcp \- Copy-on-write replication on S3QL file systems
.
@@ -144,7 +144,7 @@ Invalid command line argument or configuration file key.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/s3qlctrl.1 b/doc/man/s3qlctrl.1
index 06eaf7b..a67ff3c 100644
--- a/doc/man/s3qlctrl.1
+++ b/doc/man/s3qlctrl.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "S3QLCTRL" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "S3QLCTRL" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
s3qlctrl \- Control a mounted S3QL file system
.
@@ -155,7 +155,7 @@ Invalid command line argument or configuration file key.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/s3qllock.1 b/doc/man/s3qllock.1
index bd6e10b..37caef8 100644
--- a/doc/man/s3qllock.1
+++ b/doc/man/s3qllock.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "S3QLLOCK" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "S3QLLOCK" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
s3qllock \- Make trees on an S3QL file system immutable
.
@@ -130,7 +130,7 @@ Invalid command line argument or configuration file key.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/s3qlrm.1 b/doc/man/s3qlrm.1
index 38f62da..0ca7326 100644
--- a/doc/man/s3qlrm.1
+++ b/doc/man/s3qlrm.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "S3QLRM" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "S3QLRM" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
s3qlrm \- Fast tree removal on S3QL file systems
.
@@ -102,7 +102,7 @@ Invalid command line argument or configuration file key.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/s3qlstat.1 b/doc/man/s3qlstat.1
index 8e1005d..d45fac9 100644
--- a/doc/man/s3qlstat.1
+++ b/doc/man/s3qlstat.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "S3QLSTAT" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "S3QLSTAT" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
s3qlstat \- Gather S3QL file system statistics
.
@@ -99,7 +99,7 @@ Invalid command line argument or configuration file key.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/man/umount.s3ql.1 b/doc/man/umount.s3ql.1
index a6986c5..ba7dd63 100644
--- a/doc/man/umount.s3ql.1
+++ b/doc/man/umount.s3ql.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "UMOUNT.S3QL" "1" "Nov 06, 2018" "2.32" "S3QL"
+.TH "UMOUNT.S3QL" "1" "Dec 28, 2018" "2.33" "S3QL"
.SH NAME
umount.s3ql \- Unmount an S3QL file system
.
@@ -108,7 +108,7 @@ Invalid command line argument or configuration file key.
.UNINDENT
.SH SEE ALSO
.sp
-The S3QL homepage is at \fI\%https://bitbucket.org/nikratio/s3ql/\fP\&.
+The S3QL homepage is at \fI\%https://github.com/s3ql/s3ql/\fP\&.
.sp
The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
diff --git a/doc/manual.pdf b/doc/manual.pdf
index 9829e21..6bc252b 100644
--- a/doc/manual.pdf
+++ b/doc/manual.pdf
Binary files differ
diff --git a/rst/about.rst b/rst/about.rst
index 75f169e..daef9de 100644
--- a/rst/about.rst
+++ b/rst/about.rst
@@ -6,7 +6,6 @@
Contributing
============
-The S3QL source code is available both on GitHub_ and BitBucket_.
+The S3QL source code is available on GitHub_.
-.. _BitBucket: https://bitbucket.org/nikratio/s3ql/
.. _GitHub: https://github.com/s3ql/main
diff --git a/rst/faq.rst b/rst/faq.rst
new file mode 100644
index 0000000..fa51342
--- /dev/null
+++ b/rst/faq.rst
@@ -0,0 +1,254 @@
+============================
+ Frequently Asked Questions
+============================
+
+
+What does "python-apsw must be linked dynamically to sqlite3" mean?
+===================================================================
+
+This error occurs if your python-apsw module is statically linked
+against SQLite. You need to recompile and install the module with the
+proper settings for dynamic linking.
+
+If you are using Ubuntu or Debian, make sure that you are **not**
+using the apsw PPA at
+https://launchpad.net/~ubuntu-rogerbinns/+archive/apsw, since this PPA
+provides statically linked packages. Instead, use the *python-apsw*
+packages shipped with Debian/Ubuntu. You can reinstall the package
+(after removing the apsw PPA from :file:`/etc/apt/sources.list` and
+:file:`/etc/apt/sources.list.d/*` with::
+
+ # dpkg --purge --force-depends python-apsw
+ # apt-get install python-apsw
+
+How can I improve the file system throughput?
+=============================================
+
+There are three possible limiting factors for file system throughput:
+
+#. Throughput from process through kernel to S3QL
+#. Compression speed
+#. Upload speed
+
+To figure out what's the limiting factor in your case, you can use the
+script :file:`contrib/benchmark.py` in the S3QL tarball. It will
+determine the individual throughputs, and also give a recommendation
+for compression algorithm and number of upload threads.
+
+Why does `df` show 1 TB of free space?
+======================================
+
+The file system size of S3QL is unlimited. However, most Unix
+utilities (including `df`) have no concept of an infinite size, so
+S3QL has to provide some numerical value. Therefore, S3QL always
+reports that the file system is 50% free, but it also reports at least
+1 TB. This means that if you store 1.5 TB you will have another 1.5 TB
+free, but if you store just 2 MB, you will still have TB free rather
+than just another 2 MB.
+
+Which operating systems are supported?
+======================================
+
+S3QL is developed on Linux, but should in principle work on all FUSE
+supported operating systems that have the required Python modules. The
+:program:`{umount.s3ql` program does some tricks which may not work on
+non-Linux systems, but you can always umount with the ``fusermount
+-u`` command provided by FUSE itself (the only difference is that it
+will not block until all data has been uploaded to S3 but return
+immediately). Please report your success (or failure) with other
+operating systems on the mailing list, so that this information can be
+extended.
+
+Is there a file size limit?
+===========================
+
+No, S3QL puts no limits on the size of your files. Any limits on
+maximum object size imposed by the storage service do not matter for
+S3QL, since files are automatically and transparently split into
+smaller blocks.
+
+Suppose I want to make a small change in a very large file. Will S3QL download and re-upload the entire file?
+=============================================================================================================
+
+No, S3QL splits files in blocks of a configurable size (default: 10 MB). So to make a small change in a big file, only one block needs to be transferred and not the entire file.
+
+I don't quite understand this de-duplication feature...
+=======================================================
+
+The great thing about data de-duplication is that you don't need to know anything about it and will still get all the benefits. Towards you, S3QL will behave and look exactly like a file system without data duplication. When talking to the storage backend, however, the S3QL will try to store identical data only once and thus occupy less space than an ordinary file system would.
+
+What does the "Transport endpoint not connected" error mean?
+============================================================
+
+It means that the file system has crashed. Please check
+:file:`mount.log` for a more useful error message and report a bug if
+appropriate. If you can't find any errors in :file:`mount.log`, the
+mount process may have "segfaulted". To confirm this, look for a
+corresponding message in the :program:`dmesg` output. If the mount process
+segfaulted, please try to obtain a C backtrace (see [[Providing
+Debugging Info]]) of the crash and file a bug report.
+
+To make the mountpoint available again (i.e., unmount the crashed file
+system), use the ``fusermount -u`` command.
+
+Before reporting a bug, please make sure that you're not just using
+the most recent S3QL version, but also the most-recent version of the
+most important dependencies (python-llfuse, python-apsw, python-lzma).
+
+What does "Backend reports that fs is still mounted elsewhere, aborting" mean?
+==============================================================================
+
+It means that either the file systems has not been unmounted cleanly,
+or the data from the most-recent mount is not yet available from the
+backend. In the former case you should try to run fsck on the computer
+where the file system has been mounted most recently. In the later
+case, waiting may fix the problem: many storage providers have a
+so-called "consistency window" for which recently uploaded data may
+not yet be available for download. If you know that your backend is
+fully consistent, or the consistency window has passed, you can also
+run fsck in this situation. S3QL will then assume that whatever data
+is missing at this point is not going to show up again in the
+future. Affected files will be moved to /lost+found.
+
+Can I access an S3QL file system on multiple computers simultaneously?
+======================================================================
+
+To share a file system between several computers, you need to have a
+method for these computers to communicate, so that they can tell each
+other when they are changing data. However, S3QL is designed to store
+data in cloud storage services which can not be used for this kind of
+communication, because different computers may end up talking to
+different servers in the cloud (and there is no way for S3QL to force
+the cloud servers to synchronize quickly and often enough).
+
+Therefore, the only way to share an S3QL file system among different
+computers is to have one "master" computer that runs *mount.s3ql*,
+and then shares the mountpoint over a network file system like NFS,
+CIFS or sshfs. If the participating computers are connected over an
+insecure network, NFS and CIFS should be combined with VPN software
+like `Tinc <http://www.tinc-vpn.org/>`_ (which is very easy to set up
+for a few computers) or OpenVPN (which is a lot more complicated).
+
+In principle, both VPN and NFS/CIFS-alike functionality could be
+integrated into S3QL to allow simultaneous mounting using
+*mount.s3ql* directly. However, consensus among the S3QL developers
+is that this is not worth the increased complexity.
+
+What maximum object size should I use?
+======================================
+
+The :cmdopt:`--max-obj-size` option of the :program:`mkfs.s3ql`
+command determines the maximum size of the data chunks that S3QL
+exchanges with the backend server.
+
+For files smaller than the maximum object size, this option has no
+effect. Files larger than the maximum object size are split into
+multiple chunks. Whenever you upload or download data from the
+backend, this is done in complete chunks. So if you have configured a
+maximum object size of 10 MB, and want to read (or write) 5 bytes in a
+100 MB file, you will still download (or upload) 10 MB of data. If you
+decreased the maximum object size to 5 MB, you'd download/upload 5 MB.
+
+On the other hand, if you want to read the whole 100 MB, and have
+configured an object size of 10 MB, S3QL will have to send 10 separate
+requests to the backend. With a maximum object size of 1 MB, there'd
+be 100 separate requests. The larger the number of requests, the more
+inefficient this becomes, because there is a fixed time associated
+with the processing of each request. Also, many storage providers
+charge a fixed amount for each request, so downloading 100 MB in one
+request of 100 MB is cheaper than downloading it with 100 requests of
+1 MB.
+
+When choosing a maximum object size, you have to find a balance
+between these two effects. The bigger the size, the less requests will
+be used, but the more data is transfered uselessly. The smaller the
+size, the more requests will be used, but less traffic will be wasted.
+
+Generally you should go with the default unless you have a good reason
+to change it. When adjusting the value, keep in mind that it only
+affects files larger than the maximum object size. So if most of your
+files are less than 1 MB, decreasing the maximum object size from the
+default 10 MB to 1 MB will have almost no effect.
+
+Is there a way to make the cache persistent / access the file system offline?
+=============================================================================
+
+No, there is no way to do this. However, for most use-cases this
+feature is actually not required. If you want to ensure that all data
+in a directory is stored in the cloud *and* available offline, all you
+need to do is store your data in a local directory that you
+periodically synchronize to an S3QL mountpoint. For example, if you
+would like to have an S3QL mountpoint with persistent cache at
+:file:`/mnt/data`, you get can this as follows:
+
+#. Mount a local block device at :file:`/mnt/data`, e.g. using ext4 or btrfs
+#. Mount an S3QL file system at :file:`/mnt/data_online` using a small
+ cache size and number of threads (eg. :cmdopt:`--threads
+ 2 --max-cache-entries 10`).
+#. Keep :file:`/mnt/data_online` synchronized with :file:`/mnt/data`
+ by either
+
+ * Periodically running rsync, e.g. by calling
+ ``rsync -aHA --delete-during --partial`` from cron, or
+
+ * Continously synchronizing using e.g. `watch.sh
+ <https://github.com/drunomics/syncd/blob/master/watch.sh>`_ or
+ `lsyncd <https://code.google.com/p/lsyncd/>`_ (these programs use
+ *inotify* to constantly monitor the source directory and
+ immediately copy over any changes)
+
+#. Now use :file:`/mnt/data` in the same way as you would use an S3QL
+ file system with a persistent cache.
+
+I would like to use S3QL with Hubic, but...
+===========================================
+
+`HubiC <http://www.hubic.com/>`_ has a terribly designed API,
+effectively no customer service, and the servers are unreliable and
+produce sporadic weird errors. Don't expect any help if you encounter
+problems with S3QL and hubiC.
+
+What's a reasonable metadata upload interval?
+=============================================
+
+The metadata upload interval can be specified using the
+:cmdopt:`--metadata-upload-interval` option of :program:`mount.s3ql`
+and a reasonable value to use is (surprise!) the default of 24 hours.
+
+To understand why intervals smaller than a few hours do not make
+sense, consider what happens during a metadata upload:
+
+#. The file system is frozen (all requests will block)
+#. The entire SQLite database holding the metadata is dumped into a
+ more space efficient format.
+#. The file system is unfrozen
+#. The dumped database is uploaded
+#. The previous metadata is backed up, and backups are rotated
+
+In other words, uploading metadata is a very expensive operation that
+typically takes several seconds to several minutes.
+
+On the other hand, consider the situation that the periodic upload is
+intended to prevent:
+
+#. Your computer crashes, and the SQLite database in your S3QL cache
+ directory is **irreparably** corrupted or lost.
+
+This is a *very* unlikely situation. When :program:`mount.s3ql` crashes
+(but your computer keeps running), the local metadata will not get
+corrupted. If your entire computer crashes (e.g. because of a power
+outage), :program:`fsck.s3ql` is almost always still able to recover the
+local metadata. You have to be exceedingly unlucky to depend on the
+periodically uploaded metadata.
+
+In other words, if you set the metadata upload interval to *x*
+hours, what you are saying is that you consider your system so
+unstable that there is a good chance that your local hard disk will be
+irreparably corrupted sometime in the next *x* hours. In such a
+situation, you should thus be **backing up your entire system every
+*x* hours** (not just the S3QL metadata). If the metadata upload
+interval coincides with the interval at which you're doing full system
+backups (not necessarily using S3QL), you are using the right
+value. If the metadata upload interval is smaller (or if you're not
+doing full system backups at all), you are probably uploading metadata
+too often.
diff --git a/rst/include/postman.rst b/rst/include/postman.rst
index 20f3b71..1fbd6ff 100644
--- a/rst/include/postman.rst
+++ b/rst/include/postman.rst
@@ -3,7 +3,7 @@
See Also
========
-The S3QL homepage is at https://bitbucket.org/nikratio/s3ql/.
+The S3QL homepage is at https://github.com/s3ql/s3ql/.
The full S3QL documentation should also be installed somewhere on your
system, common locations are :file:`/usr/share/doc/s3ql` or
diff --git a/rst/index.rst b/rst/index.rst
index 51981a7..795b2b7 100644
--- a/rst/index.rst
+++ b/rst/index.rst
@@ -20,6 +20,7 @@
authinfo
contrib
tips
+ faq
issues
man/index
resources
diff --git a/rst/installation.rst b/rst/installation.rst
index 9b30afd..a33d2a4 100644
--- a/rst/installation.rst
+++ b/rst/installation.rst
@@ -10,18 +10,6 @@ installed first. The best method to satisfy these dependencies depends
on your distribution.
-The following instructions are for S3QL |version| and should be
-applicable to any system. The `S3QL Wiki
-<https://bitbucket.org/nikratio/s3ql/wiki/Home>`_ contains `additional
-help <https://bitbucket.org/nikratio/s3ql/wiki/Installation>`_ help
-for specific distributions and operating systems. Note, however, that
-S3QL wiki is editable by anyone. The information there has thus not
-been vetted by the S3QL maintainers, and may be wrong, out-of-date, or
-even dangerous. Generally, you should only follow steps from the Wiki
-that you fully understand yourself, and fall back on the instructions
-below when in doubt.
-
-
Dependencies
============
@@ -57,9 +45,9 @@ that is not the case.
the official module from the systemd developers.
* `apsw <https://github.com/rogerbinns/apsw>`_, version 3.7.0 or
newer.
- * `llfuse <https://bitbucket.org/nikratio/python-llfuse/>`_, any
+ * `llfuse <https://pypi.org/project/llfuse/>`_, any
version between 1.0 (inclusive) and 2.0 (exclusive)
- * `dugong <https://bitbucket.org/nikratio/python-dugong/>`_, any
+ * `dugong <https://pypi.org/project/dugong/>`_, any
version between 3.4 (inclusive) and 4.0 (exclusive)
* `pytest <http://pytest.org/>`_, version 2.7 or newer (optional, to run unit tests)
@@ -77,13 +65,13 @@ Installing S3QL
To build and install S3QL itself, proceed as follows:
-1. Download S3QL from https://bitbucket.org/nikratio/s3ql/downloads
+1. Download S3QL from https://github.com/s3ql/s3ql/releases
2. Unpack it into a folder of your choice
3. Run `python3 setup.py build_ext --inplace` to build S3QL.
4. Run `python3 -m pytest tests/` to run a self-test. If this fails, ask
for help on the `mailing list
<http://groups.google.com/group/s3ql>`_ or report a bug in the
- `issue tracker <https://bitbucket.org/nikratio/s3ql/issues>`_.
+ `issue tracker <https://github.com/s3ql/s3ql/issues>`_.
Now you have three options:
diff --git a/rst/issues.rst b/rst/issues.rst
index 56bab84..bdd69a5 100644
--- a/rst/issues.rst
+++ b/rst/issues.rst
@@ -17,11 +17,9 @@ Known Issues
size of 4 kB) is therefore not recommended. Being exceptionally
unlucky may also be a disadvantage.
-* S3QL does not support Access Control Lists (ACLs). This is due to a
- bug in the FUSE library and will therefore hopefully be fixed at
- some point. See `issue #16
- <https://bitbucket.org/nikratio/s3ql/issue/16/support-access-control-lists-acls>`_
- for more details.
+* S3QL does not support Access Control Lists (ACLs). There is nothing
+ fundamentally that prevents this, someone just has to write the
+ necessary code.
* As of Linux kernel 3.5 S3QL file systems do not implement the "write
protect" bit on directories. In other words, even if a directory has
@@ -69,14 +67,13 @@ Known Issues
bug has already been fixed in recent find versions.
* The `umount` and `fusermount -u` commands will *not* block until all
- data has been uploaded to the backend. (this is a FUSE limitation
- that will hopefully be removed in the future, see `issue #1
- <https://bitbucket.org/nikratio/s3ql/issue/1/blocking-fusermount-and-umount>`_). If
- you use either command to unmount an S3QL file system, you have to
- take care to explicitly wait for the `mount.s3ql` process to
- terminate before you shut down or restart the system. Therefore it
- is generally not a good idea to mount an S3QL file system in
- `/etc/fstab` (you should use a dedicated init script instead).
+ data has been uploaded to the backend. (this is a FUSE limitation,
+ cf. https://github.com/libfuse/libfuse/issues/1). If you use either
+ command to unmount an S3QL file system, you have to take care to
+ explicitly wait for the `mount.s3ql` process to terminate before you
+ shut down or restart the system. Therefore it is generally not a
+ good idea to mount an S3QL file system in `/etc/fstab` (you should
+ use a dedicated init script instead).
* S3QL relies on the backends not to run out of space. This is a given
for big storage providers like Amazon S3 or Google Storage, but you
diff --git a/rst/man/expire_backups.rst b/rst/man/expire_backups.rst
index a330dd2..bdfb13a 100644
--- a/rst/man/expire_backups.rst
+++ b/rst/man/expire_backups.rst
@@ -102,6 +102,6 @@ Exit Codes
See Also
========
-|command| is shipped as part of S3QL, https://bitbucket.org/nikratio/s3ql/.
+|command| is shipped as part of S3QL, https://github.com/s3ql/s3ql/.
.. |command| replace:: :program:`expire_backups`
diff --git a/rst/man/pcp.rst b/rst/man/pcp.rst
index 173e0a3..672fe9c 100644
--- a/rst/man/pcp.rst
+++ b/rst/man/pcp.rst
@@ -46,6 +46,6 @@ Exit Codes
See Also
========
-|command| is shipped as part of S3QL, https://bitbucket.org/nikratio/s3ql/.
+|command| is shipped as part of S3QL, https://github.com/s3ql/s3ql/.
.. |command| replace:: :program:`pcp`
diff --git a/rst/mount.rst b/rst/mount.rst
index 112a748..0ebd799 100644
--- a/rst/mount.rst
+++ b/rst/mount.rst
@@ -188,8 +188,7 @@ init job (instead of using :file:`/etc/fstab`. When using systemd,
* file systems mounted in :file:`/etc/fstab` will be unmounted with the
:program:`umount` command, so your system will not wait until all data has
been uploaded but shutdown (or restart) immediately (this is a
- FUSE limitation, see `issue #1
- <https://bitbucket.org/nikratio/s3ql/issue/1/blocking-fusermount-and-umount>`_).
+ FUSE limitation, cf https://github.com/libfuse/libfuse/issues/1).
* There is no way to tell the system that mounting S3QL requires a
Python interpreter to be available, so it may attempt to run
diff --git a/rst/resources.rst b/rst/resources.rst
index 57a4618..6e6b9cb 100644
--- a/rst/resources.rst
+++ b/rst/resources.rst
@@ -9,9 +9,7 @@ Further Resources / Getting Help
If you have questions or problems with S3QL that you weren't able to
resolve with this manual, you might want to consider the following other resources:
-* The `S3QL Wiki <https://bitbucket.org/nikratio/s3ql/wiki>`_
-
-* The `S3QL FAQ <https://bitbucket.org/nikratio/s3ql/wiki/FAQ>`_
+* The `S3QL Wiki <https://github.com/s3ql/s3ql/wiki>`_
* The `S3QL Mailing List <http://groups.google.com/group/s3ql>`_. You
can subscribe by sending a mail to
@@ -19,4 +17,4 @@ resolve with this manual, you might want to consider the following other resourc
Please report any bugs you may encounter in the `Issue Tracker
-<https://bitbucket.org/nikratio/s3ql/issues>`_.
+<https://github.com/s3ql/s3ql/issues>`_.
diff --git a/src/s3ql.egg-info/PKG-INFO b/src/s3ql.egg-info/PKG-INFO
index 8e42059..1b55302 100644
--- a/src/s3ql.egg-info/PKG-INFO
+++ b/src/s3ql.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: s3ql
-Version: 2.32
+Version: 2.33
Summary: a full-featured file system for online data storage
Home-page: https://bitbucket.org/nikratio/s3ql/
Author: Nikolaus Rath
@@ -9,7 +9,7 @@ License: GPLv3
Download-URL: https://bitbucket.org/nikratio/s3ql/downloads
Description: ..
NOTE: We cannot use sophisticated ReST syntax here because this
- file is rendered by Bitbucket.
+ file is rendered by GitHub.
======
S3QL
@@ -149,7 +149,7 @@ Description: ..
Contributing
============
- The S3QL source code is available both on GitHub_ and BitBucket_.
+ The S3QL source code is available on GitHub_.
Professional Support
--------------------
@@ -158,11 +158,9 @@ Description: ..
.. _`S3QL User's Guide`: http://www.rath.org/s3ql-docs/index.html
.. _`S3QL Wiki`: https://bitbucket.org/nikratio/s3ql/wiki/
- .. _`Installation Instructions`: https://bitbucket.org/nikratio/s3ql/wiki/Installation
.. _`S3QL FAQ`: https://bitbucket.org/nikratio/s3ql/wiki/FAQ
.. _`S3QL Mailing List`: http://groups.google.com/group/s3ql
.. _`GitHub Issue Tracker`: https://github.com/s3ql/s3ql/issues
- .. _BitBucket: https://bitbucket.org/nikratio/s3ql/
.. _GitHub: https://github.com/s3ql/main
.. _`Rath Consulting`: http://www.rath-consulting.biz/
diff --git a/src/s3ql.egg-info/SOURCES.txt b/src/s3ql.egg-info/SOURCES.txt
index 678a5be..4d77919 100644
--- a/src/s3ql.egg-info/SOURCES.txt
+++ b/src/s3ql.egg-info/SOURCES.txt
@@ -3,18 +3,6 @@ LICENSE
README.rst
setup.cfg
setup.py
-/home/nikratio/in-progress/s3ql/doc/man/fsck.s3ql.1
-/home/nikratio/in-progress/s3ql/doc/man/mkfs.s3ql.1
-/home/nikratio/in-progress/s3ql/doc/man/mount.s3ql.1
-/home/nikratio/in-progress/s3ql/doc/man/s3ql_oauth_client.1
-/home/nikratio/in-progress/s3ql/doc/man/s3ql_verify.1
-/home/nikratio/in-progress/s3ql/doc/man/s3qladm.1
-/home/nikratio/in-progress/s3ql/doc/man/s3qlcp.1
-/home/nikratio/in-progress/s3ql/doc/man/s3qlctrl.1
-/home/nikratio/in-progress/s3ql/doc/man/s3qllock.1
-/home/nikratio/in-progress/s3ql/doc/man/s3qlrm.1
-/home/nikratio/in-progress/s3ql/doc/man/s3qlstat.1
-/home/nikratio/in-progress/s3ql/doc/man/umount.s3ql.1
bin/fsck.s3ql
bin/mkfs.s3ql
bin/mount.s3ql
@@ -44,6 +32,7 @@ doc/html/authinfo.html
doc/html/backends.html
doc/html/contrib.html
doc/html/durability.html
+doc/html/faq.html
doc/html/fsck.html
doc/html/impl_details.html
doc/html/index.html
@@ -59,75 +48,41 @@ doc/html/special.html
doc/html/tips.html
doc/html/umount.html
doc/html/_sources/about.rst.txt
-doc/html/_sources/about.txt
doc/html/_sources/adm.rst.txt
-doc/html/_sources/adm.txt
doc/html/_sources/authinfo.rst.txt
-doc/html/_sources/authinfo.txt
doc/html/_sources/backends.rst.txt
-doc/html/_sources/backends.txt
doc/html/_sources/contrib.rst.txt
-doc/html/_sources/contrib.txt
doc/html/_sources/durability.rst.txt
-doc/html/_sources/durability.txt
+doc/html/_sources/faq.rst.txt
doc/html/_sources/fsck.rst.txt
-doc/html/_sources/fsck.txt
doc/html/_sources/impl_details.rst.txt
-doc/html/_sources/impl_details.txt
doc/html/_sources/index.rst.txt
-doc/html/_sources/index.txt
doc/html/_sources/installation.rst.txt
-doc/html/_sources/installation.txt
doc/html/_sources/issues.rst.txt
-doc/html/_sources/issues.txt
doc/html/_sources/mkfs.rst.txt
-doc/html/_sources/mkfs.txt
doc/html/_sources/mount.rst.txt
-doc/html/_sources/mount.txt
doc/html/_sources/resources.rst.txt
-doc/html/_sources/resources.txt
doc/html/_sources/special.rst.txt
-doc/html/_sources/special.txt
doc/html/_sources/tips.rst.txt
-doc/html/_sources/tips.txt
doc/html/_sources/umount.rst.txt
-doc/html/_sources/umount.txt
doc/html/_sources/include/about.rst.txt
-doc/html/_sources/include/about.txt
doc/html/_sources/include/exitcodes.rst.txt
-doc/html/_sources/include/exitcodes.txt
doc/html/_sources/include/postman.rst.txt
-doc/html/_sources/include/postman.txt
doc/html/_sources/man/adm.rst.txt
-doc/html/_sources/man/adm.txt
doc/html/_sources/man/cp.rst.txt
-doc/html/_sources/man/cp.txt
doc/html/_sources/man/ctrl.rst.txt
-doc/html/_sources/man/ctrl.txt
doc/html/_sources/man/expire_backups.rst.txt
-doc/html/_sources/man/expire_backups.txt
doc/html/_sources/man/fsck.rst.txt
-doc/html/_sources/man/fsck.txt
doc/html/_sources/man/index.rst.txt
-doc/html/_sources/man/index.txt
doc/html/_sources/man/lock.rst.txt
-doc/html/_sources/man/lock.txt
doc/html/_sources/man/mkfs.rst.txt
-doc/html/_sources/man/mkfs.txt
doc/html/_sources/man/mount.rst.txt
-doc/html/_sources/man/mount.txt
doc/html/_sources/man/oauth_client.rst.txt
-doc/html/_sources/man/oauth_client.txt
doc/html/_sources/man/pcp.rst.txt
-doc/html/_sources/man/pcp.txt
doc/html/_sources/man/rm.rst.txt
-doc/html/_sources/man/rm.txt
doc/html/_sources/man/stat.rst.txt
-doc/html/_sources/man/stat.txt
doc/html/_sources/man/umount.rst.txt
-doc/html/_sources/man/umount.txt
doc/html/_sources/man/verify.rst.txt
-doc/html/_sources/man/verify.txt
doc/html/_static/ajax-loader.gif
doc/html/_static/basic.css
doc/html/_static/comment-bright.png
@@ -181,7 +136,6 @@ doc/latex/make.bat
doc/latex/manual.aux
doc/latex/manual.idx
doc/latex/manual.out
-doc/latex/manual.pdf
doc/latex/manual.tex
doc/latex/manual.toc
doc/latex/python.ist
@@ -191,7 +145,6 @@ doc/latex/sphinxhighlight.sty
doc/latex/sphinxhowto.cls
doc/latex/sphinxmanual.cls
doc/latex/sphinxmulticell.sty
-doc/latex/tabulary.sty
doc/man/fsck.s3ql.1
doc/man/mkfs.s3ql.1
doc/man/mount.s3ql.1
@@ -211,6 +164,7 @@ rst/backends.rst
rst/conf.py
rst/contrib.rst
rst/durability.rst
+rst/faq.rst
rst/fsck.rst
rst/impl_details.rst
rst/index.rst
@@ -313,9 +267,5 @@ tests/t5_fsck.py
tests/t5_full.py
tests/t5_lock_rm.py
tests/t6_upgrade.py
-tests/.pytest_cache/.gitignore
-tests/.pytest_cache/README.md
-tests/.pytest_cache/v/cache/lastfailed
-tests/.pytest_cache/v/cache/nodeids
util/cmdline_lexer.py
util/sphinx_pipeinclude.py \ No newline at end of file
diff --git a/src/s3ql/__init__.py b/src/s3ql/__init__.py
index 2065901..86ebda5 100644
--- a/src/s3ql/__init__.py
+++ b/src/s3ql/__init__.py
@@ -38,7 +38,7 @@ assert logging.LOG_ONCE # prevent warnings about unused module
from llfuse import ROOT_INODE
-VERSION = '2.32'
+VERSION = '2.33'
RELEASE = '%s' % VERSION
# TODO: On next revision bump, remove upgrade code from backend/comprenc.py and
diff --git a/src/s3ql/fsck.py b/src/s3ql/fsck.py
index a0a227a..b2c4a96 100644
--- a/src/s3ql/fsck.py
+++ b/src/s3ql/fsck.py
@@ -1315,8 +1315,8 @@ def renumber_inodes(db):
create_tables(db)
for table in ('names', 'blocks', 'objects'):
- db.execute('DROP TABLE %s' % table)
- db.execute('ALTER TABLE %s_old RENAME TO %s' % (table, table))
+ db.execute('INSERT INTO %s SELECT * FROM %s_old' % (table, table))
+ db.execute('DROP TABLE %s_old' % table)
log.info('..mapping..')
db.execute('CREATE TEMPORARY TABLE inode_map (rowid INTEGER PRIMARY KEY AUTOINCREMENT, id INTEGER UNIQUE)')
diff --git a/tests/.pytest_cache/.gitignore b/tests/.pytest_cache/.gitignore
deleted file mode 100644
index 2f50ec6..0000000
--- a/tests/.pytest_cache/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-# created by pytest automatically, do not change
-* \ No newline at end of file
diff --git a/tests/.pytest_cache/README.md b/tests/.pytest_cache/README.md
deleted file mode 100644
index bb78ba0..0000000
--- a/tests/.pytest_cache/README.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# pytest cache directory #
-
-This directory contains data from the pytest's cache plugin,
-which provides the `--lf` and `--ff` options, as well as the `cache` fixture.
-
-**Do not** commit this to version control.
-
-See [the docs](https://docs.pytest.org/en/latest/cache.html) for more information.
diff --git a/tests/.pytest_cache/v/cache/lastfailed b/tests/.pytest_cache/v/cache/lastfailed
deleted file mode 100644
index 9e26dfe..0000000
--- a/tests/.pytest_cache/v/cache/lastfailed
+++ /dev/null
@@ -1 +0,0 @@
-{} \ No newline at end of file
diff --git a/tests/.pytest_cache/v/cache/nodeids b/tests/.pytest_cache/v/cache/nodeids
deleted file mode 100644
index 42fe6c2..0000000
--- a/tests/.pytest_cache/v/cache/nodeids
+++ /dev/null
@@ -1,376 +0,0 @@
-[
- "t1_backends.py::test_read_write[local/aes]",
- "t1_backends.py::test_read_write[mock-s3c/aes]",
- "t1_backends.py::test_read_write[mock-gs/aes]",
- "t1_backends.py::test_read_write[mock-swift/aes0]",
- "t1_backends.py::test_read_write[mock-swift/aes1]",
- "t1_backends.py::test_read_write[mock-swift/aes2]",
- "t1_backends.py::test_read_write[local/aes+zlib]",
- "t1_backends.py::test_read_write[mock-s3c/aes+zlib]",
- "t1_backends.py::test_read_write[mock-gs/aes+zlib]",
- "t1_backends.py::test_read_write[mock-swift/aes+zlib0]",
- "t1_backends.py::test_read_write[mock-swift/aes+zlib1]",
- "t1_backends.py::test_read_write[mock-swift/aes+zlib2]",
- "t1_backends.py::test_read_write[local/plain]",
- "t1_backends.py::test_read_write[mock-s3c/plain]",
- "t1_backends.py::test_read_write[mock-gs/plain]",
- "t1_backends.py::test_read_write[mock-swift/plain0]",
- "t1_backends.py::test_read_write[mock-swift/plain1]",
- "t1_backends.py::test_read_write[mock-swift/plain2]",
- "t1_backends.py::test_read_write[local/zlib]",
- "t1_backends.py::test_read_write[mock-s3c/zlib]",
- "t1_backends.py::test_read_write[mock-gs/zlib]",
- "t1_backends.py::test_read_write[mock-swift/zlib0]",
- "t1_backends.py::test_read_write[mock-swift/zlib1]",
- "t1_backends.py::test_read_write[mock-swift/zlib2]",
- "t1_backends.py::test_read_write[local/bzip2]",
- "t1_backends.py::test_read_write[mock-s3c/bzip2]",
- "t1_backends.py::test_read_write[mock-gs/bzip2]",
- "t1_backends.py::test_read_write[mock-swift/bzip20]",
- "t1_backends.py::test_read_write[mock-swift/bzip21]",
- "t1_backends.py::test_read_write[mock-swift/bzip22]",
- "t1_backends.py::test_read_write[local/lzma]",
- "t1_backends.py::test_read_write[mock-s3c/lzma]",
- "t1_backends.py::test_read_write[mock-gs/lzma]",
- "t1_backends.py::test_read_write[mock-swift/lzma0]",
- "t1_backends.py::test_read_write[mock-swift/lzma1]",
- "t1_backends.py::test_read_write[mock-swift/lzma2]",
- "t1_backends.py::test_read_write[local/raw]",
- "t1_backends.py::test_read_write[mock-s3c/raw]",
- "t1_backends.py::test_read_write[mock-gs/raw]",
- "t1_backends.py::test_read_write[mock-swift/raw0]",
- "t1_backends.py::test_read_write[mock-swift/raw1]",
- "t1_backends.py::test_read_write[mock-swift/raw2]",
- "t1_backends.py::test_issue114[mock-swift/raw0]",
- "t1_backends.py::test_issue114[mock-swift/raw1]",
- "t1_backends.py::test_issue114[mock-swift/raw2]",
- "t1_backends.py::test_complex_meta[local/raw]",
- "t1_backends.py::test_complex_meta[mock-s3c/raw]",
- "t1_backends.py::test_complex_meta[mock-gs/raw]",
- "t1_backends.py::test_complex_meta[mock-swift/raw0]",
- "t1_backends.py::test_complex_meta[mock-swift/raw1]",
- "t1_backends.py::test_complex_meta[mock-swift/raw2]",
- "t1_backends.py::test_complex_meta[local/plain]",
- "t1_backends.py::test_complex_meta[local/aes]",
- "t1_backends.py::test_complex_meta[local/zlib]",
- "t1_backends.py::test_list[local/aes]",
- "t1_backends.py::test_list[mock-s3c/aes]",
- "t1_backends.py::test_list[mock-gs/aes]",
- "t1_backends.py::test_list[mock-swift/aes0]",
- "t1_backends.py::test_list[mock-swift/aes1]",
- "t1_backends.py::test_list[mock-swift/aes2]",
- "t1_backends.py::test_readslowly[local/raw]",
- "t1_backends.py::test_readslowly[mock-s3c/raw]",
- "t1_backends.py::test_readslowly[mock-gs/raw]",
- "t1_backends.py::test_readslowly[mock-swift/raw0]",
- "t1_backends.py::test_readslowly[mock-swift/raw1]",
- "t1_backends.py::test_readslowly[mock-swift/raw2]",
- "t1_backends.py::test_readslowly[local/plain]",
- "t1_backends.py::test_readslowly[local/aes]",
- "t1_backends.py::test_readslowly[local/zlib]",
- "t1_backends.py::test_readslowly[local/aes+zlib]",
- "t1_backends.py::test_delete[local/aes]",
- "t1_backends.py::test_delete[mock-s3c/aes]",
- "t1_backends.py::test_delete[mock-gs/aes]",
- "t1_backends.py::test_delete[mock-swift/aes0]",
- "t1_backends.py::test_delete[mock-swift/aes1]",
- "t1_backends.py::test_delete[mock-swift/aes2]",
- "t1_backends.py::test_delete_multi[local/aes]",
- "t1_backends.py::test_delete_multi[mock-s3c/aes]",
- "t1_backends.py::test_delete_multi[mock-gs/aes]",
- "t1_backends.py::test_delete_multi[mock-swift/aes0]",
- "t1_backends.py::test_delete_multi[mock-swift/aes1]",
- "t1_backends.py::test_delete_multi[mock-swift/aes2]",
- "t1_backends.py::test_clear[local/aes]",
- "t1_backends.py::test_clear[mock-s3c/aes]",
- "t1_backends.py::test_clear[mock-gs/aes]",
- "t1_backends.py::test_clear[mock-swift/aes0]",
- "t1_backends.py::test_clear[mock-swift/aes1]",
- "t1_backends.py::test_clear[mock-swift/aes2]",
- "t1_backends.py::test_copy[local/raw]",
- "t1_backends.py::test_copy[mock-s3c/raw]",
- "t1_backends.py::test_copy[mock-gs/raw]",
- "t1_backends.py::test_copy[mock-swift/raw0]",
- "t1_backends.py::test_copy[mock-swift/raw1]",
- "t1_backends.py::test_copy[mock-swift/raw2]",
- "t1_backends.py::test_copy[local/plain]",
- "t1_backends.py::test_copy[local/aes]",
- "t1_backends.py::test_copy[local/zlib]",
- "t1_backends.py::test_copy_special[local/raw]",
- "t1_backends.py::test_copy_special[mock-s3c/raw]",
- "t1_backends.py::test_copy_special[mock-gs/raw]",
- "t1_backends.py::test_copy_special[mock-swift/raw0]",
- "t1_backends.py::test_copy_special[mock-swift/raw1]",
- "t1_backends.py::test_copy_special[mock-swift/raw2]",
- "t1_backends.py::test_copy_newmeta[local/raw]",
- "t1_backends.py::test_copy_newmeta[mock-s3c/raw]",
- "t1_backends.py::test_copy_newmeta[mock-gs/raw]",
- "t1_backends.py::test_copy_newmeta[mock-swift/raw0]",
- "t1_backends.py::test_copy_newmeta[mock-swift/raw1]",
- "t1_backends.py::test_copy_newmeta[mock-swift/raw2]",
- "t1_backends.py::test_copy_newmeta[local/aes]",
- "t1_backends.py::test_copy_newmeta[local/zlib]",
- "t1_backends.py::test_rename[local/raw]",
- "t1_backends.py::test_rename[mock-s3c/raw]",
- "t1_backends.py::test_rename[mock-gs/raw]",
- "t1_backends.py::test_rename[mock-swift/raw0]",
- "t1_backends.py::test_rename[mock-swift/raw1]",
- "t1_backends.py::test_rename[mock-swift/raw2]",
- "t1_backends.py::test_rename[local/aes]",
- "t1_backends.py::test_rename[local/zlib]",
- "t1_backends.py::test_rename_newmeta[local/raw]",
- "t1_backends.py::test_rename_newmeta[mock-s3c/raw]",
- "t1_backends.py::test_rename_newmeta[mock-gs/raw]",
- "t1_backends.py::test_rename_newmeta[mock-swift/raw0]",
- "t1_backends.py::test_rename_newmeta[mock-swift/raw1]",
- "t1_backends.py::test_rename_newmeta[mock-swift/raw2]",
- "t1_backends.py::test_rename_newmeta[local/aes]",
- "t1_backends.py::test_rename_newmeta[local/zlib]",
- "t1_backends.py::test_update_meta[local/raw]",
- "t1_backends.py::test_update_meta[mock-s3c/raw]",
- "t1_backends.py::test_update_meta[mock-gs/raw]",
- "t1_backends.py::test_update_meta[mock-swift/raw0]",
- "t1_backends.py::test_update_meta[mock-swift/raw1]",
- "t1_backends.py::test_update_meta[mock-swift/raw2]",
- "t1_backends.py::test_update_meta[local/aes]",
- "t1_backends.py::test_update_meta[local/zlib]",
- "t1_backends.py::test_copy_error[mock-s3c/raw]",
- "t1_backends.py::test_copy_error[mock-s3c/aes]",
- "t1_backends.py::test_copy_error[mock-s3c/zlib]",
- "t1_backends.py::test_corruption[local/aes]",
- "t1_backends.py::test_corruption[local/aes+zlib]",
- "t1_backends.py::test_corruption[local/zlib]",
- "t1_backends.py::test_corruption[local/bzip2]",
- "t1_backends.py::test_corruption[local/lzma]",
- "t1_backends.py::test_extra_data[local/aes]",
- "t1_backends.py::test_extra_data[local/aes+zlib]",
- "t1_backends.py::test_extra_data[local/zlib]",
- "t1_backends.py::test_extra_data[local/bzip2]",
- "t1_backends.py::test_extra_data[local/lzma]",
- "t1_backends.py::test_multi_packet[local/raw]",
- "t1_backends.py::test_multi_packet[mock-s3c/raw]",
- "t1_backends.py::test_multi_packet[mock-gs/raw]",
- "t1_backends.py::test_multi_packet[mock-swift/raw0]",
- "t1_backends.py::test_multi_packet[mock-swift/raw1]",
- "t1_backends.py::test_multi_packet[mock-swift/raw2]",
- "t1_backends.py::test_multi_packet[local/plain]",
- "t1_backends.py::test_multi_packet[mock-s3c/plain]",
- "t1_backends.py::test_multi_packet[mock-gs/plain]",
- "t1_backends.py::test_multi_packet[mock-swift/plain0]",
- "t1_backends.py::test_multi_packet[mock-swift/plain1]",
- "t1_backends.py::test_multi_packet[mock-swift/plain2]",
- "t1_backends.py::test_multi_packet[local/aes]",
- "t1_backends.py::test_multi_packet[mock-s3c/aes]",
- "t1_backends.py::test_multi_packet[mock-gs/aes]",
- "t1_backends.py::test_multi_packet[mock-swift/aes0]",
- "t1_backends.py::test_multi_packet[mock-swift/aes1]",
- "t1_backends.py::test_multi_packet[mock-swift/aes2]",
- "t1_backends.py::test_multi_packet[local/aes+zlib]",
- "t1_backends.py::test_multi_packet[mock-s3c/aes+zlib]",
- "t1_backends.py::test_multi_packet[mock-gs/aes+zlib]",
- "t1_backends.py::test_multi_packet[mock-swift/aes+zlib0]",
- "t1_backends.py::test_multi_packet[mock-swift/aes+zlib1]",
- "t1_backends.py::test_multi_packet[mock-swift/aes+zlib2]",
- "t1_backends.py::test_multi_packet[local/zlib]",
- "t1_backends.py::test_multi_packet[mock-s3c/zlib]",
- "t1_backends.py::test_multi_packet[mock-gs/zlib]",
- "t1_backends.py::test_multi_packet[mock-swift/zlib0]",
- "t1_backends.py::test_multi_packet[mock-swift/zlib1]",
- "t1_backends.py::test_multi_packet[mock-swift/zlib2]",
- "t1_backends.py::test_issue431[local/raw]",
- "t1_backends.py::test_issue431[local/plain]",
- "t1_backends.py::test_issue431[local/aes]",
- "t1_backends.py::test_issue431[local/aes+zlib]",
- "t1_backends.py::test_issue431[local/zlib]",
- "t1_backends.py::test_encryption[local/aes]",
- "t1_backends.py::test_encryption[local/aes+zlib]",
- "t1_backends.py::test_replay[local/aes]",
- "t1_backends.py::test_replay[local/aes+zlib]",
- "t1_backends.py::test_list_bug[mock-s3c/raw]",
- "t1_backends.py::test_corrupted_get[mock-s3c/aes+zlib]",
- "t1_backends.py::test_corrupted_meta[mock-s3c/raw]",
- "t1_backends.py::test_corrupted_meta[mock-s3c/aes+zlib]",
- "t1_backends.py::test_corrupted_put[mock-s3c/raw]",
- "t1_backends.py::test_corrupted_put[mock-s3c/aes+zlib]",
- "t1_backends.py::test_get_s3error[mock-s3c/raw]",
- "t1_backends.py::test_get_s3error[mock-s3c/aes+zlib]",
- "t1_backends.py::test_head_s3error[mock-s3c/raw]",
- "t1_backends.py::test_head_s3error[mock-s3c/aes+zlib]",
- "t1_backends.py::test_delete_s3error[mock-s3c/raw]",
- "t1_backends.py::test_backoff[mock-s3c/raw]",
- "t1_backends.py::test_httperror[mock-s3c/raw]",
- "t1_backends.py::test_put_s3error_early[mock-s3c/raw]",
- "t1_backends.py::test_put_s3error_early[mock-s3c/aes+zlib]",
- "t1_backends.py::test_put_s3error_med[mock-s3c/raw]",
- "t1_backends.py::test_put_s3error_med[mock-s3c/aes+zlib]",
- "t1_backends.py::test_put_s3error_late[mock-s3c/raw]",
- "t1_backends.py::test_put_s3error_late[mock-s3c/aes+zlib]",
- "t1_backends.py::test_issue58[mock-s3c/raw]",
- "t1_backends.py::test_issue58[mock-s3c/aes+zlib]",
- "t1_backends.py::test_issue58_b[mock-s3c/raw]",
- "t1_backends.py::test_issue58_b[mock-s3c/aes+zlib]",
- "t1_backends.py::test_expired_token_get[mock-gs/raw]",
- "t1_backends.py::test_expired_token_get[mock-gs/aes+zlib]",
- "t1_backends.py::test_expired_token_put[mock-gs/raw]",
- "t1_backends.py::test_expired_token_put[mock-gs/aes+zlib]",
- "t1_backends.py::test_conn_abort[mock-s3c/raw]",
- "t1_backends.py::test_conn_abort[mock-s3c/aes+zlib]",
- "t1_dump.py::DumpTests::test_1_vals_1",
- "t1_dump.py::DumpTests::test_1_vals_2",
- "t1_dump.py::DumpTests::test_1_vals_3",
- "t1_dump.py::DumpTests::test_2_buf_auto",
- "t1_dump.py::DumpTests::test_2_buf_fixed",
- "t1_dump.py::DumpTests::test_3_deltas_1",
- "t1_dump.py::DumpTests::test_3_deltas_2",
- "t1_dump.py::DumpTests::test_3_deltas_3",
- "t1_dump.py::DumpTests::test_5_multi",
- "t1_dump.py::DumpTests::test_transactions",
- "t1_retry.py::test_retry",
- "t1_retry.py::test_retry_generator",
- "t1_retry.py::test_is_retry",
- "t1_retry.py::test_logging",
- "t1_serialization.py::test_simple",
- "t1_serialization.py::test_wrong_key",
- "t1_serialization.py::test_cmplx_value",
- "t1_serialization.py::test_thaw_errors",
- "t1_serialization.py::test_checksum",
- "t1_serialization.py::test_checksum_bytes",
- "t2_block_cache.py::test_thread_hang",
- "t2_block_cache.py::test_get",
- "t2_block_cache.py::test_expire",
- "t2_block_cache.py::test_upload",
- "t2_block_cache.py::test_remove_referenced",
- "t2_block_cache.py::test_remove_cache",
- "t2_block_cache.py::test_upload_race",
- "t2_block_cache.py::test_expire_race",
- "t2_block_cache.py::test_parallel_expire",
- "t2_block_cache.py::test_remove_cache_db",
- "t2_block_cache.py::test_remove_db",
- "t2_block_cache.py::test_issue_241",
- "t3_fs_api.py::test_getattr_root",
- "t3_fs_api.py::test_create",
- "t3_fs_api.py::test_extstat",
- "t3_fs_api.py::test_getxattr",
- "t3_fs_api.py::test_link",
- "t3_fs_api.py::test_listxattr",
- "t3_fs_api.py::test_read",
- "t3_fs_api.py::test_readdir",
- "t3_fs_api.py::test_forget",
- "t3_fs_api.py::test_removexattr",
- "t3_fs_api.py::test_rename",
- "t3_fs_api.py::test_replace_file",
- "t3_fs_api.py::test_replace_dir",
- "t3_fs_api.py::test_setattr_one",
- "t3_fs_api.py::test_setattr_two",
- "t3_fs_api.py::test_truncate",
- "t3_fs_api.py::test_truncate_0",
- "t3_fs_api.py::test_setxattr",
- "t3_fs_api.py::test_names",
- "t3_fs_api.py::test_statfs",
- "t3_fs_api.py::test_symlink",
- "t3_fs_api.py::test_unlink",
- "t3_fs_api.py::test_rmdir",
- "t3_fs_api.py::test_relink",
- "t3_fs_api.py::test_write",
- "t3_fs_api.py::test_failsafe",
- "t3_fs_api.py::test_create_open",
- "t3_fs_api.py::test_edit",
- "t3_fs_api.py::test_copy_tree",
- "t3_fs_api.py::test_copy_tree_2",
- "t3_fs_api.py::test_lock_tree",
- "t3_fs_api.py::test_remove_tree",
- "t3_fsck.py::fsck_tests::test_blocks_checksum",
- "t3_fsck.py::fsck_tests::test_blocks_obj_id",
- "t3_fsck.py::fsck_tests::test_cache",
- "t3_fsck.py::fsck_tests::test_contents_inode",
- "t3_fsck.py::fsck_tests::test_contents_inode_p",
- "t3_fsck.py::fsck_tests::test_contents_name",
- "t3_fsck.py::fsck_tests::test_ext_attrs_inode",
- "t3_fsck.py::fsck_tests::test_ext_attrs_name",
- "t3_fsck.py::fsck_tests::test_inode_blocks_block_id",
- "t3_fsck.py::fsck_tests::test_inode_blocks_inode",
- "t3_fsck.py::fsck_tests::test_inodes_size",
- "t3_fsck.py::fsck_tests::test_lof1",
- "t3_fsck.py::fsck_tests::test_lof2",
- "t3_fsck.py::fsck_tests::test_loops",
- "t3_fsck.py::fsck_tests::test_missing_obj",
- "t3_fsck.py::fsck_tests::test_name_refcount",
- "t3_fsck.py::fsck_tests::test_obj_refcounts",
- "t3_fsck.py::fsck_tests::test_objects_id",
- "t3_fsck.py::fsck_tests::test_orphaned_block",
- "t3_fsck.py::fsck_tests::test_orphaned_inode",
- "t3_fsck.py::fsck_tests::test_orphaned_name",
- "t3_fsck.py::fsck_tests::test_orphaned_obj",
- "t3_fsck.py::fsck_tests::test_symlinks_inode",
- "t3_fsck.py::fsck_tests::test_tmpfile",
- "t3_fsck.py::fsck_tests::test_unix_blocks",
- "t3_fsck.py::fsck_tests::test_unix_child",
- "t3_fsck.py::fsck_tests::test_unix_nomode_dir",
- "t3_fsck.py::fsck_tests::test_unix_nomode_reg",
- "t3_fsck.py::fsck_tests::test_unix_rdev",
- "t3_fsck.py::fsck_tests::test_unix_size",
- "t3_fsck.py::fsck_tests::test_unix_size_symlink",
- "t3_fsck.py::fsck_tests::test_unix_symlink_no_target",
- "t3_fsck.py::fsck_tests::test_unix_target",
- "t3_fsck.py::fsck_tests::test_wrong_block_refcount",
- "t3_fsck.py::fsck_tests::test_wrong_inode_refcount",
- "t3_inode_cache.py::cache_tests::test_create",
- "t3_inode_cache.py::cache_tests::test_del",
- "t3_inode_cache.py::cache_tests::test_get",
- "t3_verify.py::test_missing[True]",
- "t3_verify.py::test_missing[False]",
- "t3_verify.py::test_corrupted_head[True]",
- "t3_verify.py::test_corrupted_head[False]",
- "t3_verify.py::test_corrupted_body[True]",
- "t3_verify.py::test_corrupted_body[False]",
- "t4_adm.py::AdmTests::test_authinfo",
- "t4_adm.py::AdmTests::test_key_recovery",
- "t4_adm.py::AdmTests::test_passphrase",
- "t4_fuse.py::TestFuse::()::test",
- "t5_cache.py::TestPerstCache::()::test",
- "t5_cache.py::TestPerstCache::()::test_cache_upload",
- "t5_cache.py::TestPerstCache::()::test_cache_flush[True]",
- "t5_cache.py::TestPerstCache::()::test_cache_flush[False]",
- "t5_cache.py::TestPerstCache::()::test_cache_flush_unclean",
- "t5_cp.py::TestCp::()::test",
- "t5_ctrl.py::TestCtrl::()::test",
- "t5_failsafe.py::TestFailsafe::()::test",
- "t5_failsafe.py::TestNewerMetadata::()::test",
- "t5_fsck.py::TestFsck::()::test",
- "t5_full.py::TestFulls3::()::test",
- "t5_full.py::TestFullrackspace::()::test",
- "t5_full.py::TestFullswift::()::test",
- "t5_full.py::TestFullgs::()::test",
- "t5_full.py::TestFulls3c::()::test",
- "t5_full.py::TestFullswiftks::()::test",
- "t5_full.py::TestFull::()::test",
- "t5_lock_rm.py::TestLockRemove::()::test",
- "t6_upgrade.py::TestswiftUpgrade::()::test[True]",
- "t6_upgrade.py::TestswiftUpgrade::()::test[False]",
- "t6_upgrade.py::Tests3cUpgrade::()::test[True]",
- "t6_upgrade.py::Tests3cUpgrade::()::test[False]",
- "t6_upgrade.py::TestPlains3Upgrade::()::test[True]",
- "t6_upgrade.py::TestPlains3Upgrade::()::test[False]",
- "t6_upgrade.py::Tests3Upgrade::()::test[True]",
- "t6_upgrade.py::Tests3Upgrade::()::test[False]",
- "t6_upgrade.py::TestgsUpgrade::()::test[True]",
- "t6_upgrade.py::TestgsUpgrade::()::test[False]",
- "t6_upgrade.py::TestrackspaceUpgrade::()::test[True]",
- "t6_upgrade.py::TestrackspaceUpgrade::()::test[False]",
- "t6_upgrade.py::TestPlainswiftUpgrade::()::test[True]",
- "t6_upgrade.py::TestPlainswiftUpgrade::()::test[False]",
- "t6_upgrade.py::TestPlaingsUpgrade::()::test[True]",
- "t6_upgrade.py::TestPlaingsUpgrade::()::test[False]",
- "t6_upgrade.py::TestPlainrackspaceUpgrade::()::test[True]",
- "t6_upgrade.py::TestPlainrackspaceUpgrade::()::test[False]",
- "t6_upgrade.py::TestPlainswiftksUpgrade::()::test[True]",
- "t6_upgrade.py::TestPlainswiftksUpgrade::()::test[False]",
- "t6_upgrade.py::TestswiftksUpgrade::()::test[True]",
- "t6_upgrade.py::TestswiftksUpgrade::()::test[False]",
- "t6_upgrade.py::TestPlains3cUpgrade::()::test[True]",
- "t6_upgrade.py::TestPlains3cUpgrade::()::test[False]",
- "t6_upgrade.py::TestUpgrade::()::test[True]",
- "t6_upgrade.py::TestUpgrade::()::test[False]",
- "t6_upgrade.py::TestPlainUpgrade::()::test[True]",
- "t6_upgrade.py::TestPlainUpgrade::()::test[False]"
-] \ No newline at end of file
diff --git a/tests/t4_fuse.py b/tests/t4_fuse.py
index 0e3f5c4..8321298 100755
--- a/tests/t4_fuse.py
+++ b/tests/t4_fuse.py
@@ -147,10 +147,13 @@ class TestFuse:
# Give mount process a little while to terminate
if self.mount_process is not None:
try:
- retry(90, lambda : self.mount_process.poll() is not None)
+ retry(10, lambda : self.mount_process.poll() is not None)
except TimeoutError:
- # Ignore errors during teardown
- pass
+ self.mount_process.terminate()
+ try:
+ self.mount_process.wait(1)
+ except subprocess.TimeoutExpired:
+ self.mount_process.kill()
shutil.rmtree(self.cache_dir)
shutil.rmtree(self.backend_dir)
diff --git a/tests/t5_cache.py b/tests/t5_cache.py
index cfdc2ea..bf4fc46 100644
--- a/tests/t5_cache.py
+++ b/tests/t5_cache.py
@@ -19,6 +19,7 @@ import os
import shutil
import tempfile
import subprocess
+import time
from os.path import join as pjoin
with open(__file__, 'rb') as fh:
@@ -137,6 +138,11 @@ class TestPerstCache(t4_fuse.TestFuse):
# Kill mount
self.flush_cache()
self.upload_meta()
+
+ # Metadata upload is not blocking, so give it some time to
+ # complete
+ time.sleep(1)
+
self.mount_process.kill()
self.mount_process.wait()
self.umount_fuse()