diff options
Diffstat (limited to 'doc/latex/manual.tex')
| -rw-r--r-- | doc/latex/manual.tex | 161 |
1 files changed, 57 insertions, 104 deletions
diff --git a/doc/latex/manual.tex b/doc/latex/manual.tex index 1a10fe3..cabba86 100644 --- a/doc/latex/manual.tex +++ b/doc/latex/manual.tex @@ -35,8 +35,14 @@ % 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{\figurename}{Fig.\@ }} +\makeatletter +\def\fnum@figure{\figurename\thefigure{}} +\makeatother +\addto\captionsenglish{\renewcommand{\tablename}{Table }} +\makeatletter +\def\fnum@table{\tablename\thetable{}} +\makeatother \addto\captionsenglish{\renewcommand{\literalblockname}{Listing}} \addto\captionsenglish{\renewcommand{\literalblockcontinuedname}{continued from previous page}} @@ -52,16 +58,19 @@ \title{S3QL Documentation} -\date{Jul 17, 2019} -\release{3.2} +\date{Sep 08, 2019} +\release{3.3} \author{Nikolaus Rath} \newcommand{\sphinxlogo}{\vbox{}} \renewcommand{\releasename}{Release} \makeindex \begin{document} -\maketitle +\pagestyle{empty} +\sphinxmaketitle +\pagestyle{plain} \sphinxtableofcontents +\pagestyle{normal} \phantomsection\label{\detokenize{index::doc}} @@ -315,7 +324,6 @@ Version 1.2b1 or newer of the \sphinxhref{http://sphinx.pocoo.org/}{Sphinx} docu With these additional dependencies installed, S3QL can be build and tested with -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{python3 setup.py build\PYGZus{}cython} \PYG{l}{python3 setup.py build\PYGZus{}ext \PYGZhy{}\PYGZhy{}inplace} @@ -333,14 +341,12 @@ behave as it does for a regular release. The HTML and PDF documentation can be generated with -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{python3 setup.py build\PYGZus{}sphinx} \end{sphinxVerbatim} and S3QL can be installed as usual with -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{python3 setup.py install }\PYG{g+ge}{[\PYGZhy{}\PYGZhy{}user]} \end{sphinxVerbatim} @@ -354,7 +360,6 @@ a good idea), you have to create additional entries in your \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/authinfo2}} file that tell S3QL what server and credentials to use for these tests. These entries have the following form: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+ge}{[\PYGZlt{}BACKEND\PYGZgt{}\PYGZhy{}test]} \PYG{l}{backend\PYGZhy{}login: }\PYG{n+nv}{\PYGZlt{}user\PYGZgt{}} @@ -372,7 +377,6 @@ testing}. For example, to run tests that need connection to a Google Storage server, you would add something like -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+ge}{[gs\PYGZhy{}test]} \PYG{l}{backend\PYGZhy{}login: GOOGIGWLONT238MD7HZ4} @@ -440,7 +444,6 @@ To create a Google Storage bucket, you can use e.g. the \sphinxhref{https://cons Storage Manager}. The storage URL for accessing the bucket in S3QL is then -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{gs://}\PYG{n+nv}{\PYGZlt{}bucketname\PYGZgt{}}\PYG{l}{/}\PYG{n+nv}{\PYGZlt{}prefix\PYGZgt{}} \end{sphinxVerbatim} @@ -451,7 +454,7 @@ S3QL. This allows you to store several S3QL file systems in the same Google Storage bucket. The Google Storage backend accepts the following backend options: -\index{gs\_backend command line option!ssl-ca-path=\textless{}path\textgreater{}}\index{ssl-ca-path=\textless{}path\textgreater{}!gs\_backend command line option} +\index{gs\_backend command line option@\spxentry{gs\_backend command line option}!ssl-ca-path=\textless{}path\textgreater{}@\spxentry{ssl-ca-path=\textless{}path\textgreater{}}}\index{ssl-ca-path=\textless{}path\textgreater{}@\spxentry{ssl-ca-path=\textless{}path\textgreater{}}!gs\_backend command line option@\spxentry{gs\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-gs-backend-arg-ssl-ca-path}}\pysigline{\sphinxbfcode{\sphinxupquote{ssl-ca-path}}\sphinxcode{\sphinxupquote{=\textless{}path\textgreater{}}}} @@ -463,7 +466,7 @@ per file. \end{fulllineitems} -\index{gs\_backend command line option!tcp-timeout}\index{tcp-timeout!gs\_backend command line option} +\index{gs\_backend command line option@\spxentry{gs\_backend command line option}!tcp-timeout@\spxentry{tcp-timeout}}\index{tcp-timeout@\spxentry{tcp-timeout}!gs\_backend command line option@\spxentry{gs\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-gs-backend-arg-tcp-timeout}}\pysigline{\sphinxbfcode{\sphinxupquote{tcp-timeout}}\sphinxcode{\sphinxupquote{}}} @@ -490,7 +493,6 @@ geographically closest storage region, but not the US Standard region The storage URL for accessing S3 buckets in S3QL has the form -\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{sphinxVerbatim} @@ -499,7 +501,6 @@ The storage URL for accessing S3 buckets in S3QL has the form object names used by S3QL. This allows you to store several S3QL file systems in the same S3 bucket. For example, the storage URL -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3://ap\PYGZhy{}south\PYGZhy{}1/foomart.net/data/s3ql\PYGZus{}backup/} \end{sphinxVerbatim} @@ -514,7 +515,7 @@ the \sphinxstyleemphasis{AWS access key id} and \sphinxstyleemphasis{AWS secret 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} +\index{s3\_backend command line option@\spxentry{s3\_backend command line option}!no-ssl@\spxentry{no-ssl}}\index{no-ssl@\spxentry{no-ssl}!s3\_backend command line option@\spxentry{s3\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-no-ssl}}\pysigline{\sphinxbfcode{\sphinxupquote{no-ssl}}\sphinxcode{\sphinxupquote{}}} @@ -522,7 +523,7 @@ Disable encrypted (https) connections and use plain HTTP instead. \end{fulllineitems} -\index{s3\_backend command line option!ssl-ca-path=\textless{}path\textgreater{}}\index{ssl-ca-path=\textless{}path\textgreater{}!s3\_backend command line option} +\index{s3\_backend command line option@\spxentry{s3\_backend command line option}!ssl-ca-path=\textless{}path\textgreater{}@\spxentry{ssl-ca-path=\textless{}path\textgreater{}}}\index{ssl-ca-path=\textless{}path\textgreater{}@\spxentry{ssl-ca-path=\textless{}path\textgreater{}}!s3\_backend command line option@\spxentry{s3\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-ssl-ca-path}}\pysigline{\sphinxbfcode{\sphinxupquote{ssl-ca-path}}\sphinxcode{\sphinxupquote{=\textless{}path\textgreater{}}}} @@ -534,7 +535,7 @@ per file. \end{fulllineitems} -\index{s3\_backend command line option!tcp-timeout}\index{tcp-timeout!s3\_backend command line option} +\index{s3\_backend command line option@\spxentry{s3\_backend command line option}!tcp-timeout@\spxentry{tcp-timeout}}\index{tcp-timeout@\spxentry{tcp-timeout}!s3\_backend command line option@\spxentry{s3\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-tcp-timeout}}\pysigline{\sphinxbfcode{\sphinxupquote{tcp-timeout}}\sphinxcode{\sphinxupquote{}}} @@ -544,7 +545,7 @@ TCP connection is closed and re-established (default: 20 seconds). \end{fulllineitems} -\index{s3\_backend command line option!sse}\index{sse!s3\_backend command line option} +\index{s3\_backend command line option@\spxentry{s3\_backend command line option}!sse@\spxentry{sse}}\index{sse@\spxentry{sse}!s3\_backend command line option@\spxentry{s3\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-sse}}\pysigline{\sphinxbfcode{\sphinxupquote{sse}}\sphinxcode{\sphinxupquote{}}} @@ -554,7 +555,7 @@ side encryption are probably rather small, and this option does \end{fulllineitems} -\index{s3\_backend command line option!it}\index{it!s3\_backend command line option} +\index{s3\_backend command line option@\spxentry{s3\_backend command line option}!it@\spxentry{it}}\index{it@\spxentry{it}!s3\_backend command line option@\spxentry{s3\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-it}}\pysigline{\sphinxbfcode{\sphinxupquote{it}}\sphinxcode{\sphinxupquote{}}} @@ -563,7 +564,7 @@ See \sphinxhref{https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-in \end{fulllineitems} -\index{s3\_backend command line option!ia}\index{ia!s3\_backend command line option} +\index{s3\_backend command line option@\spxentry{s3\_backend command line option}!ia@\spxentry{ia}}\index{ia@\spxentry{ia}!s3\_backend command line option@\spxentry{s3\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-ia}}\pysigline{\sphinxbfcode{\sphinxupquote{ia}}\sphinxcode{\sphinxupquote{}}} @@ -572,7 +573,7 @@ See \sphinxhref{https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-in \end{fulllineitems} -\index{s3\_backend command line option!oia}\index{oia!s3\_backend command line option} +\index{s3\_backend command line option@\spxentry{s3\_backend command line option}!oia@\spxentry{oia}}\index{oia@\spxentry{oia}!s3\_backend command line option@\spxentry{s3\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-oia}}\pysigline{\sphinxbfcode{\sphinxupquote{oia}}\sphinxcode{\sphinxupquote{}}} @@ -581,7 +582,7 @@ See \sphinxhref{https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-in \end{fulllineitems} -\index{s3\_backend command line option!rrs}\index{rrs!s3\_backend command line option} +\index{s3\_backend command line option@\spxentry{s3\_backend command line option}!rrs@\spxentry{rrs}}\index{rrs@\spxentry{rrs}!s3\_backend command line option@\spxentry{s3\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3-backend-arg-rrs}}\pysigline{\sphinxbfcode{\sphinxupquote{rrs}}\sphinxcode{\sphinxupquote{}}} @@ -608,20 +609,19 @@ 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 -\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{sphinxVerbatim} -for Keystone (v2) authentication, the storage URL is +for Keystone (v2 and v3) authentication, the storage URL is -\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{sphinxVerbatim} Note that when using Keystone authentication, you can (and have to) -specify the storage region of the container as well. +specify the storage region of the container as well. Also note that when +using Keystone v3 authentication, the \sphinxcode{\sphinxupquote{domain}} option is required. In both cases, \sphinxstyleemphasis{hostname} name should be the name of the authentication server. The storage container must already exist (most @@ -639,7 +639,7 @@ is required, the OpenStack username alone may be used as backend login. The OpenStack backend accepts the following backend options: -\index{swift\_backend command line option!no-ssl}\index{no-ssl!swift\_backend command line option} +\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!no-ssl@\spxentry{no-ssl}}\index{no-ssl@\spxentry{no-ssl}!swift\_backend command line option@\spxentry{swift\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-no-ssl}}\pysigline{\sphinxbfcode{\sphinxupquote{no-ssl}}\sphinxcode{\sphinxupquote{}}} @@ -650,7 +650,7 @@ storage server is determined by the authentication server. \end{fulllineitems} -\index{swift\_backend command line option!ssl-ca-path=\textless{}path\textgreater{}}\index{ssl-ca-path=\textless{}path\textgreater{}!swift\_backend command line option} +\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!ssl-ca-path=\textless{}path\textgreater{}@\spxentry{ssl-ca-path=\textless{}path\textgreater{}}}\index{ssl-ca-path=\textless{}path\textgreater{}@\spxentry{ssl-ca-path=\textless{}path\textgreater{}}!swift\_backend command line option@\spxentry{swift\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-ssl-ca-path}}\pysigline{\sphinxbfcode{\sphinxupquote{ssl-ca-path}}\sphinxcode{\sphinxupquote{=\textless{}path\textgreater{}}}} @@ -662,7 +662,7 @@ per file. \end{fulllineitems} -\index{swift\_backend command line option!tcp-timeout}\index{tcp-timeout!swift\_backend command line option} +\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!tcp-timeout@\spxentry{tcp-timeout}}\index{tcp-timeout@\spxentry{tcp-timeout}!swift\_backend command line option@\spxentry{swift\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-tcp-timeout}}\pysigline{\sphinxbfcode{\sphinxupquote{tcp-timeout}}\sphinxcode{\sphinxupquote{}}} @@ -672,7 +672,7 @@ TCP connection is closed and re-established (default: 20 seconds). \end{fulllineitems} -\index{swift\_backend command line option!disable-expect100}\index{disable-expect100!swift\_backend command line option} +\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!disable-expect100@\spxentry{disable-expect100}}\index{disable-expect100@\spxentry{disable-expect100}!swift\_backend command line option@\spxentry{swift\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-disable-expect100}}\pysigline{\sphinxbfcode{\sphinxupquote{disable-expect100}}\sphinxcode{\sphinxupquote{}}} @@ -685,7 +685,7 @@ than once in some circumstances. \end{fulllineitems} -\index{swift\_backend command line option!no-feature-detection}\index{no-feature-detection!swift\_backend command line option} +\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!no-feature-detection@\spxentry{no-feature-detection}}\index{no-feature-detection@\spxentry{no-feature-detection}!swift\_backend command line option@\spxentry{swift\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-no-feature-detection}}\pysigline{\sphinxbfcode{\sphinxupquote{no-feature-detection}}\sphinxcode{\sphinxupquote{}}} @@ -696,6 +696,26 @@ configurations. \end{fulllineitems} +\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!domain@\spxentry{domain}}\index{domain@\spxentry{domain}!swift\_backend command line option@\spxentry{swift\_backend command line option}} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-domain}}\pysigline{\sphinxbfcode{\sphinxupquote{domain}}\sphinxcode{\sphinxupquote{}}} +If this option is specified, S3QL will use the Keystone v3 API. The +default domain for OpenStack installations is \sphinxcode{\sphinxupquote{Default}}. If this +option is specified without setting the \sphinxcode{\sphinxupquote{project-domain}} option, this +will be used for both the project and the user domain. Note: some +instances of the Keystone v3 API prefer the use of UUIDs rather than +names for tenant (called project in newer OpenStack versions), as +well as domains. + +\end{fulllineitems} + +\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!project-domain@\spxentry{project-domain}}\index{project-domain@\spxentry{project-domain}!swift\_backend command line option@\spxentry{swift\_backend command line option}}\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!In simple cases, the project domain will be the same as the auth@\spxentry{In simple cases, the project domain will be the same as the auth}}\index{In simple cases, the project domain will be the same as the auth@\spxentry{In simple cases, the project domain will be the same as the auth}!swift\_backend command line option@\spxentry{swift\_backend command line option}}\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!domain. If the {}`project-domain{}` option is not specified, it will be@\spxentry{domain. If the {}`project-domain{}` option is not specified, it will be}}\index{domain. If the {}`project-domain{}` option is not specified, it will be@\spxentry{domain. If the {}`project-domain{}` option is not specified, it will be}!swift\_backend command line option@\spxentry{swift\_backend command line option}}\index{swift\_backend command line option@\spxentry{swift\_backend command line option}!assumed to be the same as the user domain.@\spxentry{assumed to be the same as the user domain.}}\index{assumed to be the same as the user domain.@\spxentry{assumed to be the same as the user domain.}!swift\_backend command line option@\spxentry{swift\_backend command line option}} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-project-domain}}\pysigline{\sphinxbfcode{\sphinxupquote{project-domain}}\sphinxcode{\sphinxupquote{}}}\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-in}}\pysigline{\sphinxbfcode{\sphinxupquote{In}}\sphinxcode{\sphinxupquote{~simple~cases}}\sphinxcode{\sphinxupquote{,~}}\sphinxbfcode{\sphinxupquote{the}}\sphinxcode{\sphinxupquote{~project~domain~will~be~the~same~as~the~auth}}}\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-it}}\pysigline{\sphinxbfcode{\sphinxupquote{domain.}}\sphinxcode{\sphinxupquote{~If~the~{}`project-domain{}`~option~is~not~specified}}\sphinxcode{\sphinxupquote{,~}}\sphinxbfcode{\sphinxupquote{it}}\sphinxcode{\sphinxupquote{~will~be}}}\phantomsection\label{\detokenize{backends:cmdoption-swift-backend-arg-assumed}}\pysigline{\sphinxbfcode{\sphinxupquote{assumed}}\sphinxcode{\sphinxupquote{~to~be~the~same~as~the~user~domain.}}} +\end{fulllineitems} + \begin{sphinxadmonition}{note}{Note:} The Swift API unfortunately lacks a number of features that S3QL @@ -715,7 +735,6 @@ just use the OpenStack/Swift backend (see above) with there is also a special \sphinxcode{\sphinxupquote{rackspace}} backend that uses a storage URL of the form -\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{sphinxVerbatim} @@ -738,7 +757,6 @@ The Rackspace backend accepts the same backend options as the 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 -\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{sphinxVerbatim} @@ -749,7 +767,7 @@ used by S3QL. This allows you to store several S3QL file systems in the same bucket. 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} +\index{s3c\_backend command line option@\spxentry{s3c\_backend command line option}!no-ssl@\spxentry{no-ssl}}\index{no-ssl@\spxentry{no-ssl}!s3c\_backend command line option@\spxentry{s3c\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-no-ssl}}\pysigline{\sphinxbfcode{\sphinxupquote{no-ssl}}\sphinxcode{\sphinxupquote{}}} @@ -757,7 +775,7 @@ Disable encrypted (https) connections and use plain HTTP instead. \end{fulllineitems} -\index{s3c\_backend command line option!ssl-ca-path=\textless{}path\textgreater{}}\index{ssl-ca-path=\textless{}path\textgreater{}!s3c\_backend command line option} +\index{s3c\_backend command line option@\spxentry{s3c\_backend command line option}!ssl-ca-path=\textless{}path\textgreater{}@\spxentry{ssl-ca-path=\textless{}path\textgreater{}}}\index{ssl-ca-path=\textless{}path\textgreater{}@\spxentry{ssl-ca-path=\textless{}path\textgreater{}}!s3c\_backend command line option@\spxentry{s3c\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-ssl-ca-path}}\pysigline{\sphinxbfcode{\sphinxupquote{ssl-ca-path}}\sphinxcode{\sphinxupquote{=\textless{}path\textgreater{}}}} @@ -769,7 +787,7 @@ per file. \end{fulllineitems} -\index{s3c\_backend command line option!tcp-timeout}\index{tcp-timeout!s3c\_backend command line option} +\index{s3c\_backend command line option@\spxentry{s3c\_backend command line option}!tcp-timeout@\spxentry{tcp-timeout}}\index{tcp-timeout@\spxentry{tcp-timeout}!s3c\_backend command line option@\spxentry{s3c\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-tcp-timeout}}\pysigline{\sphinxbfcode{\sphinxupquote{tcp-timeout}}\sphinxcode{\sphinxupquote{}}} @@ -779,7 +797,7 @@ TCP connection is closed and re-established (default: 20 seconds). \end{fulllineitems} -\index{s3c\_backend command line option!disable-expect100}\index{disable-expect100!s3c\_backend command line option} +\index{s3c\_backend command line option@\spxentry{s3c\_backend command line option}!disable-expect100@\spxentry{disable-expect100}}\index{disable-expect100@\spxentry{disable-expect100}!s3c\_backend command line option@\spxentry{s3c\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-disable-expect100}}\pysigline{\sphinxbfcode{\sphinxupquote{disable-expect100}}\sphinxcode{\sphinxupquote{}}} @@ -792,7 +810,7 @@ than once in some circumstances. \end{fulllineitems} -\index{s3c\_backend command line option!dumb-copy}\index{dumb-copy!s3c\_backend command line option} +\index{s3c\_backend command line option@\spxentry{s3c\_backend command line option}!dumb-copy@\spxentry{dumb-copy}}\index{dumb-copy@\spxentry{dumb-copy}!s3c\_backend command line option@\spxentry{s3c\_backend command line option}} \begin{fulllineitems} \phantomsection\label{\detokenize{backends:cmdoption-s3c-backend-arg-dumb-copy}}\pysigline{\sphinxbfcode{\sphinxupquote{dumb-copy}}\sphinxcode{\sphinxupquote{}}} @@ -822,7 +840,6 @@ mountpoint). The storage URL for local storage is -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{local://}\PYG{n+nv}{\PYGZlt{}path\PYGZgt{}} \end{sphinxVerbatim} @@ -1128,7 +1145,6 @@ neglected over long periods of time. A S3QL file system is created with the \sphinxstyleliteralstrong{\sphinxupquote{mkfs.s3ql}} command. It has the following syntax: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{mkfs.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}} \end{sphinxVerbatim} @@ -1214,7 +1230,6 @@ file systems. The file system \sphinxstyleemphasis{must not be mounted} when usi The syntax is -\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{sphinxVerbatim} @@ -1267,7 +1282,6 @@ that the different actions take. To change the passphrase of a file system, use the \sphinxcode{\sphinxupquote{passphrase}} subcommand: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3qladm passphrase }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}} \end{sphinxVerbatim} @@ -1297,7 +1311,6 @@ file system at the same time. To upgrade a file system from the previous to the current revision, execute -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3qladm upgrade }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}} \end{sphinxVerbatim} @@ -1307,7 +1320,6 @@ execute \label{\detokenize{adm:deleting-a-file-system}} A file system can be deleted with: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3qladm clear }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}} \end{sphinxVerbatim} @@ -1323,7 +1335,6 @@ created backup copies. The command -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3qladm download\PYGZhy{}metadata }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}} \end{sphinxVerbatim} @@ -1345,7 +1356,6 @@ for help on the mailing list first (see {\hyperref[\detokenize{resources:resourc A S3QL file system is mounted with the \sphinxstyleliteralstrong{\sphinxupquote{mount.s3ql}} command. It has the following syntax: -\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{sphinxVerbatim} @@ -1623,7 +1633,6 @@ data de-duplication feature of S3QL. The syntax of \sphinxcode{\sphinxupquote{s3qlcp}} is: -\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{sphinxVerbatim} @@ -1696,14 +1705,12 @@ any backup program. You can get more information about a mounted S3QL file system with the \sphinxcode{\sphinxupquote{s3qlstat}} command. It has the following syntax: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3qlstat }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mountpoint\PYGZgt{}} \end{sphinxVerbatim} This will print out something like this -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{Directory entries: 1488068} \PYG{l}{Inodes: 1482991} @@ -1738,7 +1745,6 @@ below). For example, to make the directory tree beneath the directory \sphinxcode{\sphinxupquote{2010-04-21}} immutable, execute -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3qllock 2010\PYGZhy{}04\PYGZhy{}21} \end{sphinxVerbatim} @@ -1782,7 +1788,6 @@ using e.g. \sphinxcode{\sphinxupquote{rm -r}}, the main reason for its existence allows you to delete immutable trees as well. The syntax is rather simple: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3qlrm }\PYG{n+nv}{\PYGZlt{}directory\PYGZgt{}} \end{sphinxVerbatim} @@ -1796,7 +1801,6 @@ be removed entirely and immediately. The \sphinxcode{\sphinxupquote{s3qlctrl}} can be used to control a mounted S3QL file system. Its syntax is -\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{sphinxVerbatim} @@ -1831,7 +1835,6 @@ Trigger a metadata upload. \label{\detokenize{umount:unmounting}}\label{\detokenize{umount::doc}} To unmount an S3QL file system, use the command: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{umount.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}mountpoint\PYGZgt{}} \end{sphinxVerbatim} @@ -1915,7 +1918,6 @@ again. The \sphinxstyleliteralstrong{\sphinxupquote{fsck.s3ql}} command has the following syntax: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{fsck.s3ql }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}} \end{sphinxVerbatim} @@ -2004,7 +2006,6 @@ affected files into the \sphinxcode{\sphinxupquote{lost+found}} directory. The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_verify}} command has the following syntax: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3ql\PYGZus{}verify }\PYG{g+ge}{[options]}\PYG{l}{ }\PYG{n+nv}{\PYGZlt{}storage url\PYGZgt{}} \end{sphinxVerbatim} @@ -2098,7 +2099,6 @@ 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: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+ge}{[s3]} \PYG{l}{storage\PYGZhy{}url: s3://} @@ -2169,7 +2169,6 @@ To recursively copy the directory \sphinxcode{\sphinxupquote{/mnt/home-backup}} \sphinxcode{\sphinxupquote{/home/joe}} using 8 parallel processes and preserving permissions, you would execute -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{pcp.py \PYGZhy{}a \PYGZhy{}\PYGZhy{}processes=8 /mnt/home\PYGZhy{}backup/ /home/joe} \end{sphinxVerbatim} @@ -2267,7 +2266,6 @@ stored in directories of the form \sphinxcode{\sphinxupquote{year-month-day\_hou directory. So for the above backup strategy, the correct invocation would be: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{expire\PYGZus{}backups.py 1 3 7 14 31} \end{sphinxVerbatim} @@ -2310,14 +2308,12 @@ By combining S3QL’s local backend with \sphinxhref{http://fuse.sourceforge.net S3QL file system on arbitrary SSH servers: first mount the remote target directory into the local filesystem, -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{sshfs user@my.server.com:/mnt/s3ql /mnt/sshfs} \end{sphinxVerbatim} and then give the mountpoint to S3QL as a local destination: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{mount.s3ql local:///mnt/sshfs/myfsdata /mnt/s3ql} \end{sphinxVerbatim} @@ -2381,7 +2377,6 @@ first instance handles all filenames starting with a-f, the second the filenames from g-l and the third covers the rest. The \sphinxcode{\sphinxupquote{+ */}} rule ensures that every instance looks into all directories. -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{c}{\PYGZsh{}!/bin/bash} @@ -2422,7 +2417,6 @@ 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} @@ -2823,7 +2817,6 @@ here in the User’s Guide. \subsection{Synopsis} \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{sphinxVerbatim} @@ -2946,7 +2939,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -3092,7 +3084,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -3284,7 +3275,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -3362,7 +3352,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -3401,7 +3390,6 @@ 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: -\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{sphinxVerbatim} @@ -3410,7 +3398,6 @@ complete command line is: Change the amount of information that is logged into \sphinxcode{\sphinxupquote{\textasciitilde{}/.s3ql/mount.log}} file. The complete syntax is: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] s3qlctrl [options] log \PYGZlt{}mountpoint\PYGZgt{} \PYGZlt{}level\PYGZgt{} [\PYGZlt{}module\PYGZgt{} [\PYGZlt{}module\PYGZgt{} ...]] \end{sphinxVerbatim} @@ -3487,7 +3474,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -3617,7 +3603,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -3699,7 +3684,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -3811,7 +3795,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -3898,7 +3881,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -4061,7 +4043,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \label{\detokenize{man/oauth_client:synopsis}} -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{s3ql\PYGZus{}oauth\PYGZus{}client }\PYG{g+ge}{[options]} \end{sphinxVerbatim} @@ -4084,30 +4065,6 @@ backend. \subsection{Options} \label{\detokenize{man/oauth_client:options}} The \sphinxstyleliteralstrong{\sphinxupquote{s3ql\_oauth\_client}} command accepts the following options: -\begin{quote} -\begin{optionlist}{3cm} -\item [-{-}log \textless{}target\textgreater{}] -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{\sphinxupquote{None}} -\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{\sphinxupquote{-{-}log}} option. -\item [-{-}debug] -Activate debugging output from all S3QL modules. Debug -messages will be written to the target specified by -the \sphinxcode{\sphinxupquote{-{-}log}} option. -\item [-{-}quiet] -be really quiet -\item [-{-}version] -just print program version and exit -\end{optionlist} -\end{quote} \subsection{Exit Codes} @@ -4141,7 +4098,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -4286,7 +4242,6 @@ system, common locations are \sphinxcode{\sphinxupquote{/usr/share/doc/s3ql}} or \subsection{Synopsis} \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{sphinxVerbatim} @@ -4364,7 +4319,6 @@ Invalid command line argument or configuration file key. \subsection{Synopsis} \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{sphinxVerbatim} @@ -4427,7 +4381,6 @@ stored in directories of the form \sphinxcode{\sphinxupquote{year-month-day\_hou directory. So for the above backup strategy, the correct invocation would be: -\fvset{hllines={, ,}}% \begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{l}{expire\PYGZus{}backups.py 1 3 7 14 31} \end{sphinxVerbatim} |