This commit is contained in:
wesbarnett 2021-05-16 23:21:17 +00:00
parent 0b6aa41a9e
commit 99d807fe0d
5 changed files with 5 additions and 15 deletions

Binary file not shown.

Binary file not shown.

View file

@ -8,15 +8,9 @@ Configuration is done via Python ini configuration files. The defaults
should be suitable for most users, so you may not need to do any configuration at all.
By default only the ``root`` snapper configuration is snapshotted.
A commented example configuration files is located at ``/etc/snap-pac.ini.example``.
A commented example configuration files is located at ``/etc/snap-pac.ini``.
To configure, copy the example configuration file:
.. code-block:: bash
cp /etc/snap-pac.ini{.example,}
Then edit with your favorite editor. The file is commented and should be
Edit with your favorite editor. The file is commented and should be
self-explanatory.
Each section corresponds with a snapper configuration. Add additional sections to add

View file

@ -98,12 +98,8 @@
<p>Configuration is done via Python ini configuration files. The defaults
should be suitable for most users, so you may not need to do any configuration at all.
By default only the <code class="docutils literal notranslate"><span class="pre">root</span></code> snapper configuration is snapshotted.</p>
<p>A commented example configuration files is located at <code class="docutils literal notranslate"><span class="pre">/etc/snap-pac.ini.example</span></code>.</p>
<p>To configure, copy the example configuration file:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cp /etc/snap-pac.ini<span class="o">{</span>.example,<span class="o">}</span>
</pre></div>
</div>
<p>Then edit with your favorite editor. The file is commented and should be
<p>A commented example configuration files is located at <code class="docutils literal notranslate"><span class="pre">/etc/snap-pac.ini</span></code>.</p>
<p>Edit with your favorite editor. The file is commented and should be
self-explanatory.</p>
<p>Each section corresponds with a snapper configuration. Add additional sections to add
other snapper configurations to be snapshotted. By default, only the root configuration

View file

@ -1 +1 @@
Search.setIndex({docnames:["configuration","examples","faq","index","installation","troubleshooting"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["configuration.rst","examples.rst","faq.rst","index.rst","installation.rst","troubleshooting.rst"],objects:{},objnames:{},objtypes:{},terms:{"0":[1,3],"00":3,"01":1,"04":2,"05":2,"1":[1,2,3],"100":[1,3],"1033":1,"1034":1,"13":1,"14":1,"2":[1,3,4],"2016":1,"22":1,"2489":3,"3":[1,3],"4":3,"42":0,"5":1,"54":1,"72":0,"7394":3,"7395":3,"79":3,"8":[1,3,4,5],"8535cef3f3c38ee69555bf67e4b5e45aa3b8c5c3":4,"boolean":0,"case":0,"default":[0,3,5],"do":[0,1,2,3,4],"final":4,"import":0,"true":0,"while":5,A:0,Be:3,By:[0,5],For:[0,2,3,4],If:3,In:[0,3],It:2,No:[2,5],That:[2,5],The:[0,1,3,4,5],Then:[0,1,4],To:[0,3,4],abov:[1,3],access:4,accord:3,action:2,ad:0,add:[0,2,5],addit:0,addition:[0,3,4],after:[1,3,5],alia:3,all:[0,1,4],along:1,also:[0,1],altern:4,an:[1,3],ani:[0,3,5],appli:0,applic:3,apr:1,ar:[0,1,3,4,5],arm:3,arthur:0,aur:3,automat:[2,3],avail:[1,3],avzq:2,awk:2,back:[2,3],backup:2,backupboot:2,bash:2,becaus:3,befor:[0,1,2,3],behavior:[2,5],being:[0,5],bin:[1,2],boot:2,bootbackup:2,breakag:3,btrf:2,build:4,c:[1,2],cach:3,call:[0,3],can:[0,1,2,3,4,5],care:3,caus:3,cdt:1,chang:[1,3],check:[1,3],chroot:3,command:[0,3],comment:0,commit:4,conditionneedsupd:3,configur:[1,3,5],conflict:[1,3],consid:5,continu:1,copi:0,correspond:[0,2],could:2,cp:0,creat:[1,3],databas:[3,5],delet:[1,2],depend:[1,3],desc_limit:0,descript:[0,2,3],desktop:3,detail:3,diff:[1,5],differ:0,directli:3,disk:[1,3],doc:[1,4],doe:[2,3],doesn:3,don:0,done:0,download:4,dure:[1,3],e:5,each:[0,1,3],easili:3,edit:0,editor:0,end:2,ensur:2,entri:0,environ:3,error:1,etc:[0,1,5],everi:0,exact:3,exampl:[2,3],exec:2,expect:5,explanatori:0,extrem:3,f7b28c61944fe30dabeeb0b01070bcc98c18bd66:4,fals:0,faq:[1,3],favorit:0,featur:3,file:[0,1,2,3,5],filter:5,find:[2,3],fingerprint:4,follow:[0,1,2,3,5],found:1,fr:1,fri:1,from:[0,3,5],full:0,fuller:[0,3],g:5,gener:4,get:3,give:5,given:1,gone:3,gpg:4,gz:4,ha:[3,5],handl:0,have:[0,2,3,4],he:[0,3],helper:3,here:[0,1],home:0,hook:[0,1,2,3,5],how:[1,2,3],html:[1,4],i:[2,4,5],icon:3,important_command:0,important_packag:0,index:4,inform:5,ini:0,instal:[0,1,2,3],instruct:[3,5],integ:0,integr:[1,3],involv:0,its:5,kei:[0,1,3,4],kernel:2,keyr:[1,3],l:2,later:0,latest:4,length:0,less:2,lib:2,like:[2,3],link:2,linux:[0,2],list:[0,1,2],live:3,ll:3,ln:2,load:[1,3],locat:[0,4],lock:5,log:[1,3],longer:[1,2],look:[1,3],lt:0,mai:[0,3],make:[3,4],man8:4,man:4,manpag:4,mark:0,matter:3,maximum:0,mean:1,method:3,mib:[1,3],mime:3,modifi:1,modul:2,more:[3,5],most:[0,3],mount:3,my:4,n:[1,3],name:[0,2],nano:1,nanorc:1,need:[0,3,4],net:3,non:2,note:[0,2,3],now:1,number:[1,2,3,4],occur:3,off:0,old:2,one:0,onli:[0,5],onlin:4,opensus:3,oper:2,option:0,other:[0,3,5],otherwis:0,output:[1,3],overridden:0,own:4,pac:[0,1,2,4,5],packag:[0,1,2,3,4],pacman:[0,1,2,3,4,5],pair:0,parent:0,part:[0,2],partial:3,partit:2,perform:[0,1,3,5],pgp:4,place:2,pm:1,possibl:3,post:[0,1,3,5],post_descript:0,posttransact:2,pre:[0,1,2,3,5],pre_descript:0,prefix:2,pretransact:2,prevent:0,previou:[3,4],print:2,probabl:2,proce:[1,3],procedur:3,process:[1,3],properli:3,provid:3,pytest:4,python:[0,4],qi:1,r:2,reason:3,releas:4,remov:[0,2,3,5],requestid:0,requir:4,resolv:[1,3],resort:3,restor:5,result:4,revert:3,rnano:1,roll:3,rollback:[1,3],root:[0,1,2,3,5],rsync:2,run:[1,2,3,4,5],s:[0,1,3,4,5],same:1,screen:3,script:3,section:[0,5],see:[1,3,5],self:0,separ:0,set:[0,3,5],setup:3,sever:[0,3],share:1,she:3,should:0,sig:4,sign:4,signatur:4,similar:3,simpl:3,simpli:4,sinc:0,singl:0,size:[1,3],snap:[0,1,2,4,5],snap_pac_skip:0,snaphot:5,snapper:[0,1,2,3,4,5],snapshot:[0,1,2,3,5],so:[0,2,3,5],some:3,someth:2,space:[0,1,3],specif:3,sphinx:4,start:4,state:[2,3],statu:[1,5],string:0,subvolum:3,sudo:[0,3],suitabl:0,sv:2,symbol:1,symlink:2,sync:3,system:[0,2,3],syu:[0,3],t:[0,1,3,5],tail:1,take:[2,3,5],taken:[2,5],tar:4,tarbal:4,target:2,temporarili:0,than:2,theme:3,thi:[0,1,2,3,4,5],thing:3,through:3,thu:3,total:[1,3],transact:[0,1,3],trigger:2,troubleshoot:3,truncat:[0,1],turn:0,type:[2,3],typic:4,unam:2,under:4,undo:[1,3],undochang:[1,3,5],unless:0,unsupport:3,up:[2,5],updat:3,upgrad:[0,2,3],us:[1,2,3,4],usb:3,user:[0,3],userdata:0,usr:[1,2],valu:0,variabl:3,verifi:4,version:4,via:0,vim:3,visit:4,wa:[1,4],wai:[1,3],want:[2,3],well:3,were:0,what:1,when:[0,2,3,5],where:4,whether:[0,3],which:[3,4,5],won:5,word:3,would:2,xtype:2,y:[0,1,3],yast:3,ye:[0,5],you:[0,1,2,3,4,5],your:[0,3,4]},titles:["Configuration","Example","FAQ","snap-pac","Installation","Troubleshooting"],titleterms:{configur:0,depend:4,document:4,environ:0,exampl:[0,1],faq:2,instal:4,pac:3,snap:3,test:4,troubleshoot:5,variabl:0}})
Search.setIndex({docnames:["configuration","examples","faq","index","installation","troubleshooting"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["configuration.rst","examples.rst","faq.rst","index.rst","installation.rst","troubleshooting.rst"],objects:{},objnames:{},objtypes:{},terms:{"0":[1,3],"00":3,"01":1,"04":2,"05":2,"1":[1,2,3],"100":[1,3],"1033":1,"1034":1,"13":1,"14":1,"2":[1,3,4],"2016":1,"22":1,"2489":3,"3":[1,3],"4":3,"42":0,"5":1,"54":1,"72":0,"7394":3,"7395":3,"79":3,"8":[1,3,4,5],"8535cef3f3c38ee69555bf67e4b5e45aa3b8c5c3":4,"boolean":0,"case":0,"default":[0,3,5],"do":[0,1,2,3,4],"final":4,"import":0,"true":0,"while":5,A:0,Be:3,By:[0,5],For:[0,2,3,4],If:3,In:[0,3],It:2,No:[2,5],That:[2,5],The:[0,1,3,4,5],Then:[1,4],To:[0,3,4],abov:[1,3],access:4,accord:3,action:2,ad:0,add:[0,2,5],addit:0,addition:[0,3,4],after:[1,3,5],alia:3,all:[0,1,4],along:1,also:[0,1],altern:4,an:[1,3],ani:[0,3,5],appli:0,applic:3,apr:1,ar:[0,1,3,4,5],arm:3,arthur:0,aur:3,automat:[2,3],avail:[1,3],avzq:2,awk:2,back:[2,3],backup:2,backupboot:2,bash:2,becaus:3,befor:[0,1,2,3],behavior:[2,5],being:[0,5],bin:[1,2],boot:2,bootbackup:2,breakag:3,btrf:2,build:4,c:[1,2],cach:3,call:[0,3],can:[0,1,2,3,4,5],care:3,caus:3,cdt:1,chang:[1,3],check:[1,3],chroot:3,command:[0,3],comment:0,commit:4,conditionneedsupd:3,configur:[1,3,5],conflict:[1,3],consid:5,continu:1,correspond:[0,2],could:2,creat:[1,3],databas:[3,5],delet:[1,2],depend:[1,3],desc_limit:0,descript:[0,2,3],desktop:3,detail:3,diff:[1,5],differ:0,directli:3,disk:[1,3],doc:[1,4],doe:[2,3],doesn:3,don:0,done:0,download:4,dure:[1,3],e:5,each:[0,1,3],easili:3,edit:0,editor:0,end:2,ensur:2,entri:0,environ:3,error:1,etc:[0,1,5],everi:0,exact:3,exampl:[2,3],exec:2,expect:5,explanatori:0,extrem:3,f7b28c61944fe30dabeeb0b01070bcc98c18bd66:4,fals:0,faq:[1,3],favorit:0,featur:3,file:[0,1,2,3,5],filter:5,find:[2,3],fingerprint:4,follow:[0,1,2,3,5],found:1,fr:1,fri:1,from:[0,3,5],full:0,fuller:[0,3],g:5,gener:4,get:3,give:5,given:1,gone:3,gpg:4,gz:4,ha:[3,5],handl:0,have:[0,2,3,4],he:[0,3],helper:3,here:[0,1],home:0,hook:[0,1,2,3,5],how:[1,2,3],html:[1,4],i:[2,4,5],icon:3,important_command:0,important_packag:0,index:4,inform:5,ini:0,instal:[0,1,2,3],instruct:[3,5],integ:0,integr:[1,3],involv:0,its:5,kei:[0,1,3,4],kernel:2,keyr:[1,3],l:2,later:0,latest:4,length:0,less:2,lib:2,like:[2,3],link:2,linux:[0,2],list:[0,1,2],live:3,ll:3,ln:2,load:[1,3],locat:[0,4],lock:5,log:[1,3],longer:[1,2],look:[1,3],lt:0,mai:[0,3],make:[3,4],man8:4,man:4,manpag:4,mark:0,matter:3,maximum:0,mean:1,method:3,mib:[1,3],mime:3,modifi:1,modul:2,more:[3,5],most:[0,3],mount:3,my:4,n:[1,3],name:[0,2],nano:1,nanorc:1,need:[0,3,4],net:3,non:2,note:[0,2,3],now:1,number:[1,2,3,4],occur:3,off:0,old:2,one:0,onli:[0,5],onlin:4,opensus:3,oper:2,option:0,other:[0,3,5],otherwis:0,output:[1,3],overridden:0,own:4,pac:[0,1,2,4,5],packag:[0,1,2,3,4],pacman:[0,1,2,3,4,5],pair:0,parent:0,part:[0,2],partial:3,partit:2,perform:[0,1,3,5],pgp:4,place:2,pm:1,possibl:3,post:[0,1,3,5],post_descript:0,posttransact:2,pre:[0,1,2,3,5],pre_descript:0,prefix:2,pretransact:2,prevent:0,previou:[3,4],print:2,probabl:2,proce:[1,3],procedur:3,process:[1,3],properli:3,provid:3,pytest:4,python:[0,4],qi:1,r:2,reason:3,releas:4,remov:[0,2,3,5],requestid:0,requir:4,resolv:[1,3],resort:3,restor:5,result:4,revert:3,rnano:1,roll:3,rollback:[1,3],root:[0,1,2,3,5],rsync:2,run:[1,2,3,4,5],s:[0,1,3,4,5],same:1,screen:3,script:3,section:[0,5],see:[1,3,5],self:0,separ:0,set:[0,3,5],setup:3,sever:[0,3],share:1,she:3,should:0,sig:4,sign:4,signatur:4,similar:3,simpl:3,simpli:4,sinc:0,singl:0,size:[1,3],snap:[0,1,2,4,5],snap_pac_skip:0,snaphot:5,snapper:[0,1,2,3,4,5],snapshot:[0,1,2,3,5],so:[0,2,3,5],some:3,someth:2,space:[0,1,3],specif:3,sphinx:4,start:4,state:[2,3],statu:[1,5],string:0,subvolum:3,sudo:[0,3],suitabl:0,sv:2,symbol:1,symlink:2,sync:3,system:[0,2,3],syu:[0,3],t:[0,1,3,5],tail:1,take:[2,3,5],taken:[2,5],tar:4,tarbal:4,target:2,temporarili:0,than:2,theme:3,thi:[0,1,2,3,4,5],thing:3,through:3,thu:3,total:[1,3],transact:[0,1,3],trigger:2,troubleshoot:3,truncat:[0,1],turn:0,type:[2,3],typic:4,unam:2,under:4,undo:[1,3],undochang:[1,3,5],unless:0,unsupport:3,up:[2,5],updat:3,upgrad:[0,2,3],us:[1,2,3,4],usb:3,user:[0,3],userdata:0,usr:[1,2],valu:0,variabl:3,verifi:4,version:4,via:0,vim:3,visit:4,wa:[1,4],wai:[1,3],want:[2,3],well:3,were:0,what:1,when:[0,2,3,5],where:4,whether:[0,3],which:[3,4,5],won:5,word:3,would:2,xtype:2,y:[0,1,3],yast:3,ye:[0,5],you:[0,1,2,3,4,5],your:[0,3,4]},titles:["Configuration","Example","FAQ","snap-pac","Installation","Troubleshooting"],titleterms:{configur:0,depend:4,document:4,environ:0,exampl:[0,1],faq:2,instal:4,pac:3,snap:3,test:4,troubleshoot:5,variabl:0}})