From 2ecfa54aee99c36d810c5636a1e6f2c48acb9929 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sun, 13 Dec 2015 15:47:03 +0100 Subject: [PATCH] ran build_api and build_usage --- docs/_static/logo.xcf | Bin 0 -> 26715 bytes docs/api.rst | 48 +++++++++++++++++++------------------- docs/usage/check.rst.inc | 6 ++++- docs/usage/create.rst.inc | 5 ++-- docs/usage/delete.rst.inc | 3 ++- docs/usage/prune.rst.inc | 2 ++ 6 files changed, 35 insertions(+), 29 deletions(-) create mode 100644 docs/_static/logo.xcf diff --git a/docs/_static/logo.xcf b/docs/_static/logo.xcf new file mode 100644 index 0000000000000000000000000000000000000000..ea9c55c26a2e3dbfb03f7356e58726ada9335971 GIT binary patch literal 26715 zcmeHQcUTlxyPuhD>@HnURFqy6v0+2(y~J3sMZFp;5>cwXAjXo<9!rd05{+VyJ&6sa zR~4zE!1kr>E(lU~>3iQZTUcB$xw+4M?)S&;^Bnf<%=yiEXXZWcd8_*QZw#{EwtAiY zI{$#R7<}Z=4x$cxETG{y{OJPCXu?ShLk&Jw(5TQ@(7LMoXq+{Sw}o$WKe()?|HhSm zYd!r!{MW!C49?@2duZ79fVK9afdT$&`mo&B`K=BN2n?}zC%-&H{8p{BAJ~5&`RSlD zNPVggKv#7D)ttBQyn~?ILW5SW_TS`ZKS(nd9NgZ~LG>}u&71tg?EN>bUcWXJ;RDyL z3tbzgB@m(Y52=o{hoa}8{@_P2Y{XLx8!6Eofp7Hi70}SLG@8CTaFe~$An0OrXy|z> zp&6vuu_7`V0Rs`WZ$(ketA`mTv6Z9*woz8(yFvlnqxIM%i76nrvLH#nH4Qc2PGR8 z34zrRJx46ve>FN&P|?sz9<7Aiz>T{5tU4CMtE{bWZdE!eO)xoO<}!KXndik#N;jnu z36&cUUH;v}Y^kD^Jk*K<11Q+;D^5lU>spk3lq^g^G51(-{5ii_>7k^Nn0oWE8-7R- zE0q1<0Ewt)_Y1g~TGpWSR5CCH!FFA6E>+sB#Fcn!UnLz=;ATUXA4@1}Rt|t)^+qns zPeh3ulmnGiI7Qe@I`oXMP!3X3fIw#VkpT~c@RZQcdaCuXuTN*!DZSuFt&!7LN1jPq zl*-mtxDEwtV0-O*4pa<5{jM{vaN)5JQ7SN;%I@bEU8x)feX8YvMMpDh$v(qw&Yrvc zda}>#yD>7oqM7WoybdSJ>RX{-kC}|S#Dj-5T-k_q_x+<>>8)(+J@lKnD%2S@H~e)C z>MZs@l`BV`;Jud%6{z#wnFoS;)cNIlba4af+^4S{th+ysY?#7mtK3 z9p{K+Ju#+I+S*tn6XvBoyLoP3z#nS9ZLY7a@$)kqC%c#tm@)d5 zN2Q{f|NQs@4|58LBqwFPLY(l!hOy=(f`&OO>l?~aF9!5e1E_Efyp;fuH1*s9S2h9i z%@ux?B^+Bm#0VF(Q74wW7{L#Br9#1fc4(3ffnyZ-C2wsKJ_s1uok?H>)>m0y zmwo!{Vb)am;R=_XGgwrGJ*ph$_9n_`93eUs^8kky)vUK^gWe|%4olSY}x5{@p!u>=^UlANFElu)6A7n|YVUnP9L08q5Fi z?M`;8;=UQ$8y%^69X@vy>d13X`7cHtMd9VW!KhO&cyQ)B)M+S=zWxj9G)iASzK1$Z zAM%o8QKz{^keh)zE%H)6hwRi>N=i|uwMkxGMRtHO>S5)=-L`~NN2oZGl7=c>r^dN6>A>Zlf;^S+HOkypwj6bUZ9>GcR%Hp7mEZG0WSO~67o5TKg{x8 zbhEIsL?mDd2%%gc%zgf2$aElyfu`vD<*r8s5)qF};o`iHd>$u1?#wLjh1cJg7YTR_ z9+g|m6PAi{p8gm(ss|moR0a7nzf8#EQn{5pKCdu8?lhXB;6sUskLKmKqEod3v51ou zb$-JnCnm74W-1j<1~{1M^cUWXZsdO`7V`Lffq;+mahR}`2c3FB?(=iO(`@ySRT|`Q z-%DA=yn^@C_f7eQ91fSpm6Mb{Ik(BDQ`F2Mvwlp@&&ha0ylF_!$a+_x!jYst`|%q+ zTrrxhAnw%k{u2(|iFx+q(c?#t{(Kyrmi@jECL}3s668jm(F2N9!0)HH4P3MT`{T!s z9y@yYyJP>pANS@RmyaG#15a2c%6zB?{D^>saVIA9uo^UR=8Wn1^y+Do$Io1KF!Ff@ zM+i^~f)h+T>9bM{C8l6U=)lez)9`K0UUW$NMsQ-u&195?Y##_;C z99>H+oo!u7(@7lIy^X9OSz%2(aJWR~tkZ-kt zCoUJI{-g&a7iB@*>6up`edC5@%UBDez@SHTnT^0S{Dou!BR0JliWDW9eHiyA+cOQkYg)*zLD*h9Q0=Lw1n z6EE)Y?W2d(N)PWvw>VX$A|XxKEFfo-^F)$@KekMDG1mhjA*U8rDmf}7gt(xY&qGwo z`C@7QgP^g!&_3N>$f+kgGs|bmJ(0XZQi_-2WeuezVzi7AnZnY7=SNly?|jBtBfq-M ztCkjvizr2nVj-dw;rL?Ct9wV5yLLPyh^v`HzBn6~lb)JFq{x#~UuEWkxIzLz!54CK zQ+|t>+6glL`>F0;{{K36`s4}xMD6h-Cx5;d{VER$ECOB!k^zZVw&-D1A}jvnMBDB@ za~3aLfG?<-Kkv(h8;)L&&IFMK^Afx!L0){M9#X^O0F`;`kVqyt8jFi+BZ{N*3)L zpUTwE5o)<@GkbSCVbp=7*F0`?_XLGXsUdJ$&$+s?2$(}(7HME(Epbz88;VVJH!JfV z!`2+Vqk2o|^`adqL+@#WLO||<6K!oq%$z@O-rRX}zMSFfe?-Mm>P@gj{4PNcNit(W z95C|W_5V6|<`jOa=KGV!Phb2!Aw#|MHp03SzPYEiX;hjcco$k3*l4V&JA;B_BeAB5 zE@o701lE9K8>jSQfU?(w6TmM<^adJ*Ks_eCnFd3dU`R9_Tj9oFRmDD4aCv0Mx&@h-ev%QOY1s#@u52}xzft=4q#H5w5;^~i?bUi zb*GZBCkMPup`)N!4*6=|gG_;t0uu6rsN_T8?G@wa9DkBkC@c~Q1wvd{C*o!&T-h?r z0?4ESnUD7ak_N5=bI-+lue}mU#XJs38v$Qjp8p$Qk3GtG&qIQb%L5gW$4UPAzXn+W zu@oTo@%|B}aFJ@N^}vOPZl~mnON3kw7w1-Tc;bqJ+h0$Z3p3~QK~n|gmJgcm+o;nU zCIZO_Op;8&YABXoiz4o4fC5TN*D8Kdc>yB&*yGH6o(jsVwSa|>1JzFt z0@XNHjT080i^8u0*&-mD$_0@xD$BXHZ0xM>?x*Dz^0;&^hlj{c`f1rfD<%b;KQV{l zy?a+v_F0boHf|i%En{VtYw>jh%Hd5i(;T!T$*)pb`O|vyggV} z7|UbhFVWdNG5L&3`66!SiwmJXHVhh#&a&v)XKL8Pd}M^sxz&8JEbrPvdtgULcwRUr zXAjtXJvo;L8wr(L#}kM-ZyujnWe+YOjKJkovjMAb=a-8Sw3c7=q43rcCn`oWg;%Tw za!Er40l9A;pI&K41&)#9ru|pl&WERSm$blV07!D zes=)ISHUXsZ!C6%*^p5#XL$xkCbWm0^K)mysXBsbGu;2K1_wIS`|FDxDWAjjQQ=rN zBS;)cW*d&x>3nLOW$b`W_e+7)}H1fWh625U1h{ zHHWK!MH&t#HxrE2AFV{)1@+|2YDXGc8HB~4wPRG+ zPtLA!W`Gx}7B+z{Uh6b#s+eC?0Z6o_9)=Ht*TL+&;pdnfJ~CgaTo4zMM!L1U1$elLnY{poR_wfRzhx0!mR@fy?UA(oAq!TI%&m$X9cCC zXaK86ATCo&tHb~01`!3i?bP6(k_DttSBbiJub=(8d-*u$?smgwEd3_pLLzCkBA*E^ zQ1C!dPDX;Vy-x8Xat*p5%>jH;CZI1+DL8yc9~Dw1-~fSHV)b-WYgW-!jU)s}Qa2>tZjNsD`5?`k#CsC55$th_`&+naD3$Gbt_g!=1x2U9-Daq92 zhWq=+TEkXsg4I&HI4(MHH(OE-dI3dRCM&O$@-uF4>kpnKr!NoxnI({Z09`;v$m;WM zt{sZB88&R&mi-+UA5^2LQd#*21lr=kWDi`l_s%O`i4-un6qhN=`SCvlOt7JX>Qjxh z3y1l8ufOD%fmK5hR0>7K!o1`w!F^17FFSHCH6JW2il9y?67#ZSE(Q%k%Fjnqw{Y;? zb46tUQ()hNeIz^na>#(5L-*XzC=ek>0)-1or-09WAA82vl}!Pq2F6ZYhMDquMRMqi2Wo#}t~eHp(H+)ikdt%XfVke70E z_qcAzC0zl8s+0*`tW1U7J9pZe>lysKoVSHw7Xw(p6AHNb3BRlv(Vc!Km zEaHjE_^FZGXIj&GF8-HVm(ar|M1~GB#!R|&G3hxj{C3(~mAnyw(~FyWJ$$w`-EsZT zF)CG}w+_i@-kgNUU=L8q2?Ard21ROiaS=~Y#7VumZ(di1b1;%bu(xw{vGO)7?Bq0; zKoY7VSs*S{L0u3O5z`^m6K%?M%zmL)VGwd)P~djav^OH=S~HwgSL|e36&CcI8>xAM zB2c_2e33v@!h3lONTxe&ysWyB&gYf02W`KT&MA?WmQYHB#U+x8qRhJo=XYcLE$qN; zw_fIpON+!5F|4=}sqppf{k~oQ7MA6);rye7*BR-rsjo%p89A?>{Iq3;CEa<`Uz2R) z;JfAc`Ad%3&X0eM|Oe2UAx2Yzb%|^pugTrL({(p7xo_~8#$X`4hxKf+i z+ZkQtAdLp_*+H7^o~ygKHH!?m9bL&oyR&ybNXO*pbP#NG(=?m4cK=1ONZLcS(N3V9 z7WQ6B3)t;!dJ|aiIOKCwsH}B&R|nf}R+e3Cz;cJp7I$j^%iWSigAwJ(Lf;+{u{~hX z^s(NfzwkrWI(3H}S?gc>*qfl;TZSz1#H`Gud&jq|Tef=F_4stK&M8TCDK9hQfAt@0 z53xN9Oh%gE@;XW8&7<2kZa$S`b_NHRfehQllRAWr;#-B>#&jFW&BD&X;p3KA~v5Ah2=7R`~sR!Z)r z9IjAOocH4A(DC2}F~MZWN(Ql309Oq03p)0KQwF*j&O@;f0n&tCMy~gn;C^13wCW$Ve*xIE4|0<*S8Y&k z!PipWYR%eWPSV9~v%t4k^B3)|dVSwQM{+28;MSX|Z$Xbx+0`)g=gl*Fsfbk(@VTL3hN1s? zPe8>39lY32-&VwYdle51(BpyjLsPDW&+Vypi*!B|7ELh+hR*8+ZW$1+tj}B)Eig{n zZ{MvLU_m!AF~Zn`w|&ZnS`tc8s3ZN+`K_~uc?=%lWMVaZ$IX=7b}XwNONB)a`d|E= zGh0?KTfJ1EUtBGenDp19x)q$*2(+5mE^dLSu>KXB@ z{z(*MN9C*Iy#&8G`^iZ?ud^nuG;_$8=Ti!Evoa_djhQ*x@N$u;Fyry*HJ!q~7(V}U zb}7FwpPJuVz`;3m6dWoMW<5Id&2T-CI{JlT=P2eb1kWV_L3efNoZvTPKRdH&a(69G z6RStK!uMp%T^9$^l;Bo#xB^7vle6o_+UrKLBw(~tP?%pGach?uzz0Wq)}yl9{!+|bCT;vR=5@RI6E<& z>KuD_GiI9hK);Ng>YW|!x?6(fX`-_HX(qG=Drg)KG_auI)D{YXg&QYpQu;_Ptni-* z=@{S%88m;-oi|{dksBX4XY+GX9{sw1)o|DTb2o$^yNIG<=yl-mI)tQWcPO}$8Dktw z!NUr~51haMR&st(De{6-xU$0c*{>6R`*!-^F#*RS?>`4i3a(2avsoY%zkPPxZ#?N! z?n;9di<0-u`z_jY^_5WV;4SAA7IFlyE-oH5c;3b;K0r-$q4t(VM zhiOsd0N6MAr)2|>YlXzIFd>k;7&-odPlZCbZb>EQ4jHTfY9UxbflvjaG>mlmQ&D_~ zjlBi00J!Z_xzehNa+$3BV?!|+PKhljl7V+bRxXp2zK=Tf%>*(o0`wVUMd-Qiy`E7D zacYS~R;dvG4gr|c(eFhPnFN>A$|S{t)L$T|0i@BZ*|Kz__7dTXzJ1HOR5g^c4ZY zVVlEnVB4_ZP0J^ep`=zSj8+gvrq;cjfLjTtT4xu>o@OlLuDu)_ooG(DV^c2_U16ek zVy0$bBVb_QUka7Rq&0&c4QFwDG#U|Z40^UIH zke5Wwr@F2go$K_*Dm9#_drgaN^z|ZG`DX26Ps~+}F&Q1&`g|m}`T@OnJ5_Ds0%p1awRCc$%s6!Z8^_@m`*u6%sRdsAfZ6e1oEC;P6K{UI$ z*eI-}%P91h>4^SP*bpa0@17ac_U^&nBKHx{w7Ge&qHmu&eCYW8_1^s_hr=e^(S9vP zG71?31-a>oPaZyecKh($(X;m51W$*qLaN@fn^iF<8K*EmFFQMrmwsi{)Oq`FLb#=a z!A)xUNy@pRvMTPqbyMej+sWVtwYbEQSQLs&WYxSo%SKKPztJ%v4O%f%0mH#r^5*9m zeY|(v==dfZ)Y642tQ7I`Uf$k0#CGtu8yzb!VkA{$NUETKD<}S^&}lXn1Gn7xL_=3U z5HU!UHza3CC1oX<*VYa1iZci3jaKXPVy{KJuExAf0$~y#8*_8dXlq!*o?AXqyEKM^ zxLdzTD+0HK1_y@(2L-O24C)`o^iY`m9xqWo++t?rGK(c$loUwHcJ z9ci>e92c3P(HFK%ax{j!gmJ$nX1_{KVkgxnCclJ)K(yx~!@5G8bjE+81IiF>{GC@N zDHgNEjYaCDAC;NRe|>G^cn3BzlN;^}>OROMWvsGBNm()2ZKN^=Q@xA6uywKnWG@?I z4L`ju5{pGbHU!mio_3bgFbfOhxqRnMunxsS*vDAlHphje8vspV4{$g?BluiQL74=i z_NG#mFCq5A7PvMF6W9!09hqKKhTQZf$Q@BzntIlM0#I)O`jC~+uIn)gD7zrZnDl5Q zT>54lx~L_lp!J%zcJnq!Rxl+UBHLDuvNu6)l?DiHqofCOaHZ6%Tq!tI%QT~Oo33i- zOE}}UCSP0`ZW0T9bt7WQoO7SH6!b=IQo1%xU7NVBO=Z_6w`m=YSu(rH>1;nG;^7VD|_;vI9+w%T(>jB!=3Fs9Ov@0=aSANjGHlbbF zLi>sa{fYjdg} ze7@48^9q&El(l@e7^Z{b87KhTsc!HE+Lx-KzNY#N_Ek-_++cM4KcQL2D z=vr!vM`YzC%ppg&ZllP{|3~hUt`oGb;ZfmOZh8iS84N{Jw1__F93^hn(DVCuI z$xwr&F0<5$F{x@F4K+xr`cs_;Q(&k;LiLu08YFG}QWKli6cZV0kPJ0QsFul4gJh^d zGSnbxDl`l=NZKkZvIeEC>d8=pq+5da$;0{U;w3{3lA#94P=jQsL4x`vLk*Il2C1X6 zDYAaaP=jQsLHbNl5WByj2FXx^WT-(h)F44+)8`6{3^hpV98XOd*ykSBf8bC<4U(Y- z$xwr2s6jH+Ad&xwn4t#AP=loTcV`SWNQN4u4hohGHAvcjfxu9MWT-*<|E@to6(8+0 Sul0Yo&$veaCryVL*Z&QhjuOTI literal 0 HcmV?d00001 diff --git a/docs/api.rst b/docs/api.rst index e16b9f181..4bc7c7635 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -2,23 +2,15 @@ API Documentation ================= -.. automodule:: borg.key +.. automodule:: borg.archiver :members: :undoc-members: -.. automodule:: borg.cache +.. automodule:: borg.upgrader :members: :undoc-members: -.. automodule:: borg.locking - :members: - :undoc-members: - -.. automodule:: borg.platform - :members: - :undoc-members: - -.. automodule:: borg.xattr +.. automodule:: borg.archive :members: :undoc-members: @@ -26,7 +18,11 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.logger +.. automodule:: borg.platform + :members: + :undoc-members: + +.. automodule:: borg.locking :members: :undoc-members: @@ -34,14 +30,6 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.archiver - :members: - :undoc-members: - -.. automodule:: borg.archive - :members: - :undoc-members: - .. automodule:: borg.lrucache :members: :undoc-members: @@ -50,7 +38,7 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.upgrader +.. automodule:: borg.xattr :members: :undoc-members: @@ -58,15 +46,15 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.platform_freebsd +.. automodule:: borg.cache :members: :undoc-members: -.. automodule:: borg.hashindex +.. automodule:: borg.key :members: :undoc-members: -.. automodule:: borg.chunker +.. automodule:: borg.logger :members: :undoc-members: @@ -78,10 +66,22 @@ API Documentation :members: :undoc-members: +.. automodule:: borg.hashindex + :members: + :undoc-members: + .. automodule:: borg.compress :members: :undoc-members: +.. automodule:: borg.chunker + :members: + :undoc-members: + .. automodule:: borg.crypto :members: :undoc-members: + +.. automodule:: borg.platform_freebsd + :members: + :undoc-members: diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index fb15b428c..020881e49 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -6,7 +6,8 @@ borg check usage: borg check [-h] [-v] [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] - [--repository-only] [--archives-only] [--repair] [--last N] + [--repository-only] [--archives-only] [--repair] + [--save-space] [--last N] [-p PREFIX] [REPOSITORY_OR_ARCHIVE] Check repository consistency @@ -30,7 +31,10 @@ borg check --repository-only only perform repository checks --archives-only only perform archives checks --repair attempt to repair any inconsistencies found + --save-space work slower, but using less space --last N only check last N archives (Default: all) + -p PREFIX, --prefix PREFIX + only consider archive names starting with this prefix Description ~~~~~~~~~~~ diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index f00685745..96460f2a9 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -35,11 +35,10 @@ borg create --umask M set umask to M (local and remote, default: 0077) --remote-path PATH set remote path to executable (default: "borg") -s, --stats print statistics for the created archive - -p, --progress, --no-progress - toggle progress display while creating the archive, + -p, --progress show progress display while creating the archive, showing Original, Compressed and Deduplicated sizes, followed by the Number of files seen and the path - being processed, default: True + being processed, default: False --filter STATUSCHARS only display items with the given status characters -e PATTERN, --exclude PATTERN exclude paths matching PATTERN diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index 587e7064e..1c7642b9b 100644 --- a/docs/usage/delete.rst.inc +++ b/docs/usage/delete.rst.inc @@ -6,7 +6,7 @@ borg delete usage: borg delete [-h] [-v] [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] [-s] - [-c] + [-c] [--save-space] [TARGET] Delete an existing repository or archive @@ -28,6 +28,7 @@ borg delete --remote-path PATH set remote path to executable (default: "borg") -s, --stats print statistics for the deleted archive -c, --cache-only delete only the local cache for the given repository + --save-space work slower, but using less space Description ~~~~~~~~~~~ diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc index 08504b5d6..d52532649 100644 --- a/docs/usage/prune.rst.inc +++ b/docs/usage/prune.rst.inc @@ -8,6 +8,7 @@ borg prune [--no-files-cache] [--umask M] [--remote-path PATH] [-n] [-s] [--keep-within WITHIN] [-H HOURLY] [-d DAILY] [-w WEEKLY] [-m MONTHLY] [-y YEARLY] [-p PREFIX] + [--save-space] [REPOSITORY] Prune repository archives according to specified rules @@ -42,6 +43,7 @@ borg prune number of yearly archives to keep -p PREFIX, --prefix PREFIX only consider archive names starting with this prefix + --save-space work slower, but using less space Description ~~~~~~~~~~~