Working on documentation

README.md

@@ -1,8 +1,9 @@
 # MediaCurator
 
 MediaCurator is a Python command line tool to manage a media database. 
-* List all the video's and their codecs with or without filters
+* List all the video’s and their information with or without filters
-* Batch recode videos to more modern codecs (x265 / AV1) based on filters: extentions, codecs ...
+* Batch find and repair/convert videos with encoding errors
+* Batch recode videos to more modern codecs (x265 / AV1) based on filters: extentions, codecs, resolutions …
 
 ## Documentation
 

docs/_sources/usage/manual.rst.txt

@@ -2,6 +2,14 @@
 Manual
 ======
 
+Name
+----
+
+    MediaCurator
+
+Synopsis
+--------
+
 .. code-block:: bash
 
     ./curator.py [list,convert] [-del]
@@ -11,6 +19,48 @@ Manual
         [-print:list,formated,verbose]
         [-dir/-files:"/mnt/media/",,"/mnt/media2/"]
 
+Description
+-----------
+
+Options
+-------
+
+list
+
+convert
+
+-del:
+
+-in:
+    [any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]
+-filters:
+    [fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]
+-out:
+    [mkv/mp4,x265/av1]
+-print:
+    [list,formated,verbose]
+-dir:
+    ["/mnt/media/",,"/mnt/media2/"]
+-files:
+    ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"]
+
+Examples
+--------
+
+
+See Also
+--------
+
+Author
+------
+
+Fabrice Quenneville
+
+
+
+
+
+
 **for multiple files or filenames use double comma separated values ",,"**
 
 default options are:
@@ -29,3 +79,13 @@ Examples:
     ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
     ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
     ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
+
+
+
+Synopsis
+
+
+
+Description
+
+

docs/_sources/usage/quickstart.rst.txt

@@ -26,6 +26,10 @@ Examples:
 
 .. code-block:: bash
 
+    # List all videos with old codec in formated format
     ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
+    # Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals
     ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
     ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
+
+More examples in :doc:`use_cases`

docs/_sources/usage/use_cases.rst.txt

@@ -1,4 +1,3 @@
-
 =========
 Use cases
 =========

docs/index.html

@@ -52,7 +52,16 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage/manual.html">Manual</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage/manual.html">Manual</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#name">Name</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#synopsis">Synopsis</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#description">Description</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#options">Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#see-also">See Also</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#author">Author</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="usage/errors.html#repairable-encoding-errors">Repairable encoding errors</a></li>

docs/searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],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":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":[3,4],"720p":[3,4],"case":0,"default":[3,4],"try":1,"while":1,For:2,The:0,Use:0,acquaint:6,activ:1,after:1,again:[1,6],all:[0,6],also:1,ani:[3,4],audio:1,av1:[0,3,4],avi:[3,4],base:0,bash:[],batch:0,befor:6,behavior:6,big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:0,com:2,comma:[3,4],command:[0,6],content:0,convert:[0,3,4,6],curat:[3,4,6],damag:[1,6],databas:0,decod:1,del:[3,4,6],delet:6,depend:1,detect:1,dir:[3,4,6],distribut:[1,2],don:1,done:6,doubl:[3,4],download:2,dry:6,encod:[0,6],error:[0,6],exampl:[1,3,4],expect:6,experi:1,extent:0,fabquennevil:2,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:0,file:[3,4,6],filenam:[3,4],filter:[0,3,4,6],find:0,flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:6,header:1,here:[1,6],http:2,index:[],inform:[0,1],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,librari:6,like:1,line:0,linux:2,list:[0,3,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:0,manual:0,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:0,modul:[],more:0,most:1,move:1,movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onli:2,open:1,option:[1,3,4],other:0,out:[3,4],output:1,packag:2,page:[],pip:2,pleas:6,possibl:1,print:[1,3,4],project:1,properli:6,python:0,quickstart:0,quit:1,raw:1,recod:0,recur:1,referenc:1,repair:[0,6],report:1,repositori:1,requir:2,resolut:0,run:[1,6],search:[],segfault:1,sei:1,separ:[3,4],serv:1,some:1,sourc:[0,1],step:1,subsd:6,substandard:6,suggest:1,take:1,thi:2,too:1,tool:0,track:1,txt:[2,3,4],type:1,uhd:[3,4],unintend:6,until:6,updat:1,use:[3,4,6],used:[1,6],using:[1,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video:[0,1,6],want:1,warn:0,when:[1,6],wich:1,without:0,wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,Use:5,bug:1,document:0,encod:1,error:1,ffmpeg:[1,2],from:2,github:2,indic:[],instal:2,issu:1,manual:3,mediacur:0,other:1,quickstart:4,repair:1,tabl:[],warn:6,welcom:0}})
+Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],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":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":[3,4],"720p":[3,4],"case":[0,4],"default":[3,4],"try":1,"while":1,For:2,The:0,Use:[0,4],acquaint:6,activ:1,after:1,again:[1,6],all:[0,4,6],also:[0,1],ani:[3,4],audio:1,author:0,av1:[0,3,4],avi:[3,4],base:0,bash:[],batch:0,befor:6,behavior:6,big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:[0,4],com:2,comma:[3,4],command:[0,6],content:0,convert:[0,3,4,6],curat:[3,4,6],damag:[1,6],databas:0,decod:1,del:[3,4,6],delet:[4,6],depend:1,descript:0,detect:1,dir:[3,4,6],distribut:[1,2],don:1,done:6,doubl:[3,4],download:2,dry:6,encod:[0,6],error:[0,6],exampl:[0,1,4],expect:6,experi:1,extent:0,fabquennevil:2,fabric:3,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:0,file:[3,4,6],filenam:[3,4],filter:[0,3,4,6],find:0,flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:6,header:1,here:[1,6],http:2,index:[],inform:[0,1],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,librari:6,like:1,line:0,linux:2,list:[0,3,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:0,manual:0,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,3,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:0,modul:[],more:[0,4],most:1,move:1,movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],name:0,necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onli:2,open:1,option:[0,1,4],origin:4,other:0,out:[3,4],output:1,packag:2,page:[],pip:2,pleas:6,possibl:1,print:[1,3,4],project:1,properli:6,python:0,quennevil:3,quickstart:0,quit:1,raw:1,recod:0,recur:1,referenc:1,repair:[0,6],report:1,repositori:1,requir:2,resolut:0,run:[1,6],search:[],see:0,segfault:1,sei:1,separ:[3,4],serv:1,some:1,sourc:[0,1],step:1,subsd:6,substandard:6,suggest:1,synopsi:0,take:1,thi:2,too:1,tool:0,track:1,txt:[2,3,4],type:1,uhd:[3,4],unintend:6,until:6,updat:1,use:[3,4,6],used:[1,6],using:[1,4,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video2:3,video:[0,1,3,4,6],want:1,warn:0,when:[1,6],wich:1,without:0,wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,Use:5,also:3,author:3,bug:1,descript:3,document:0,encod:1,error:1,exampl:3,ffmpeg:[1,2],from:2,github:2,indic:[],instal:2,issu:1,manual:3,mediacur:0,name:3,option:3,other:1,quickstart:4,repair:1,see:3,synopsi:3,tabl:[],warn:6,welcom:0}})

docs/usage/manual.html

@@ -36,6 +36,14 @@
             
   <div class="section" id="manual">
 <h1>Manual<a class="headerlink" href="#manual" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="name">
+<h2>Name<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>MediaCurator</p>
+</div></blockquote>
+</div>
+<div class="section" id="synopsis">
+<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py <span class="o">[</span>list,convert<span class="o">]</span> <span class="o">[</span>-del<span class="o">]</span>
     <span class="o">[</span>-in:any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid<span class="o">]</span>
     <span class="o">[</span>-filters:fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv<span class="o">]</span>
@@ -44,6 +52,39 @@
     <span class="o">[</span>-dir/-files:<span class="s2">&quot;/mnt/media/&quot;</span>,,<span class="s2">&quot;/mnt/media2/&quot;</span><span class="o">]</span>
 </pre></div>
 </div>
+</div>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="options">
+<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
+<p>list</p>
+<p>convert</p>
+<p>-del:</p>
+<dl class="simple">
+<dt>-in:</dt><dd><p>[any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]</p>
+</dd>
+<dt>-filters:</dt><dd><p>[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]</p>
+</dd>
+<dt>-out:</dt><dd><p>[mkv/mp4,x265/av1]</p>
+</dd>
+<dt>-print:</dt><dd><p>[list,formated,verbose]</p>
+</dd>
+<dt>-dir:</dt><dd><p>[“/mnt/media/”,,”/mnt/media2/”]</p>
+</dd>
+<dt>-files:</dt><dd><p>[“/mnt/media/video.avi”,,”/mnt/media2/video2.mp4”]</p>
+</dd>
+</dl>
+</div>
+<div class="section" id="examples">
+<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="see-also">
+<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="author">
+<h2>Author<a class="headerlink" href="#author" title="Permalink to this headline">¶</a></h2>
+<p>Fabrice Quenneville</p>
 <p><strong>for multiple files or filenames use double comma separated values “,,”</strong></p>
 <p>default options are:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>-in:any
@@ -58,6 +99,9 @@
 ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
 </pre></div>
 </div>
+<p>Synopsis</p>
+<p>Description</p>
+</div>
 </div>
 
 
@@ -82,9 +126,19 @@
 <h3>Navigation</h3>
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Manual</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Manual</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#name">Name</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#description">Description</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#see-also">See Also</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#author">Author</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
 </ul>

docs/usage/quickstart.html

@@ -16,7 +16,7 @@
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Use cases" href="use_cases.html" />
+    <link rel="next" title="Manual" href="manual.html" />
     <link rel="prev" title="Installation" href="installation.html" />
    
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -53,11 +53,14 @@
 </pre></div>
 </div>
 <p>Examples:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py list -filters:old -print:formated -dir:/mnt/media/ &gt;&gt; ../medlist.txt
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># List all videos with old codec in formated format</span>
+./curator.py list -filters:old -print:formated -dir:/mnt/media/ &gt;&gt; ../medlist.txt
+<span class="c1"># Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals</span>
 ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:<span class="s2">&quot;/mnt/media/Movies/&quot;</span>
 ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
 </pre></div>
 </div>
+<p>More examples in <a class="reference internal" href="use_cases.html"><span class="doc">Use cases</span></a></p>
 </div>
 
 
@@ -82,8 +85,10 @@
 <h3>Navigation</h3>
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual.html">Manual</a></li>
 <li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
 </ul>
@@ -93,7 +98,7 @@
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
       <li>Previous: <a href="installation.html" title="previous chapter">Installation</a></li>
-      <li>Next: <a href="use_cases.html" title="next chapter">Use cases</a></li>
+      <li>Next: <a href="manual.html" title="next chapter">Manual</a></li>
   </ul></li>
 </ul>
 </div>

docs/usage/use_cases.html

@@ -17,7 +17,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Errors" href="errors.html" />
-    <link rel="prev" title="Quickstart" href="quickstart.html" />
+    <link rel="prev" title="Manual" href="manual.html" />
    
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
   
@@ -60,8 +60,10 @@
 <h3>Navigation</h3>
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual.html">Manual</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
 </ul>
@@ -70,7 +72,7 @@
 <h3>Related Topics</h3>
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="quickstart.html" title="previous chapter">Quickstart</a></li>
+      <li>Previous: <a href="manual.html" title="previous chapter">Manual</a></li>
       <li>Next: <a href="errors.html" title="next chapter">Errors</a></li>
   </ul></li>
 </ul>

docsource/build/html/_sources/usage/manual.rst.txt

@@ -2,6 +2,14 @@
 Manual
 ======
 
+Name
+----
+
+    MediaCurator
+
+Synopsis
+--------
+
 .. code-block:: bash
 
     ./curator.py [list,convert] [-del]
@@ -11,6 +19,48 @@ Manual
         [-print:list,formated,verbose]
         [-dir/-files:"/mnt/media/",,"/mnt/media2/"]
 
+Description
+-----------
+
+Options
+-------
+
+list
+
+convert
+
+-del:
+
+-in:
+    [any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]
+-filters:
+    [fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]
+-out:
+    [mkv/mp4,x265/av1]
+-print:
+    [list,formated,verbose]
+-dir:
+    ["/mnt/media/",,"/mnt/media2/"]
+-files:
+    ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"]
+
+Examples
+--------
+
+
+See Also
+--------
+
+Author
+------
+
+Fabrice Quenneville
+
+
+
+
+
+
 **for multiple files or filenames use double comma separated values ",,"**
 
 default options are:
@@ -29,3 +79,13 @@ Examples:
     ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
     ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
     ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
+
+
+
+Synopsis
+
+
+
+Description
+
+

docsource/build/html/_sources/usage/quickstart.rst.txt

@@ -26,6 +26,10 @@ Examples:
 
 .. code-block:: bash
 
+    # List all videos with old codec in formated format
     ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
+    # Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals
     ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
     ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
+
+More examples in :doc:`use_cases`

docsource/build/html/_sources/usage/use_cases.rst.txt

@@ -1,4 +1,3 @@
-
 =========
 Use cases
 =========

docsource/build/html/index.html

@@ -52,7 +52,16 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage/manual.html">Manual</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage/manual.html">Manual</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#name">Name</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#synopsis">Synopsis</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#description">Description</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#options">Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#see-also">See Also</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#author">Author</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="usage/errors.html#repairable-encoding-errors">Repairable encoding errors</a></li>

docsource/build/html/searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],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":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":[3,4],"720p":[3,4],"case":0,"default":[3,4],"try":1,"while":1,For:2,The:0,Use:0,acquaint:6,activ:1,after:1,again:[1,6],all:[0,6],also:1,ani:[3,4],audio:1,av1:[0,3,4],avi:[3,4],base:0,bash:[],batch:0,befor:6,behavior:6,big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:0,com:2,comma:[3,4],command:[0,6],content:0,convert:[0,3,4,6],curat:[3,4,6],damag:[1,6],databas:0,decod:1,del:[3,4,6],delet:6,depend:1,detect:1,dir:[3,4,6],distribut:[1,2],don:1,done:6,doubl:[3,4],download:2,dry:6,encod:[0,6],error:[0,6],exampl:[1,3,4],expect:6,experi:1,extent:0,fabquennevil:2,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:0,file:[3,4,6],filenam:[3,4],filter:[0,3,4,6],find:0,flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:6,header:1,here:[1,6],http:2,index:[],inform:[0,1],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,librari:6,like:1,line:0,linux:2,list:[0,3,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:0,manual:0,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:0,modul:[],more:0,most:1,move:1,movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onli:2,open:1,option:[1,3,4],other:0,out:[3,4],output:1,packag:2,page:[],pip:2,pleas:6,possibl:1,print:[1,3,4],project:1,properli:6,python:0,quickstart:0,quit:1,raw:1,recod:0,recur:1,referenc:1,repair:[0,6],report:1,repositori:1,requir:2,resolut:0,run:[1,6],search:[],segfault:1,sei:1,separ:[3,4],serv:1,some:1,sourc:[0,1],step:1,subsd:6,substandard:6,suggest:1,take:1,thi:2,too:1,tool:0,track:1,txt:[2,3,4],type:1,uhd:[3,4],unintend:6,until:6,updat:1,use:[3,4,6],used:[1,6],using:[1,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video:[0,1,6],want:1,warn:0,when:[1,6],wich:1,without:0,wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,Use:5,bug:1,document:0,encod:1,error:1,ffmpeg:[1,2],from:2,github:2,indic:[],instal:2,issu:1,manual:3,mediacur:0,other:1,quickstart:4,repair:1,tabl:[],warn:6,welcom:0}})
+Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],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":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":[3,4],"720p":[3,4],"case":[0,4],"default":[3,4],"try":1,"while":1,For:2,The:0,Use:[0,4],acquaint:6,activ:1,after:1,again:[1,6],all:[0,4,6],also:[0,1],ani:[3,4],audio:1,author:0,av1:[0,3,4],avi:[3,4],base:0,bash:[],batch:0,befor:6,behavior:6,big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:[0,4],com:2,comma:[3,4],command:[0,6],content:0,convert:[0,3,4,6],curat:[3,4,6],damag:[1,6],databas:0,decod:1,del:[3,4,6],delet:[4,6],depend:1,descript:0,detect:1,dir:[3,4,6],distribut:[1,2],don:1,done:6,doubl:[3,4],download:2,dry:6,encod:[0,6],error:[0,6],exampl:[0,1,4],expect:6,experi:1,extent:0,fabquennevil:2,fabric:3,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:0,file:[3,4,6],filenam:[3,4],filter:[0,3,4,6],find:0,flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:6,header:1,here:[1,6],http:2,index:[],inform:[0,1],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,librari:6,like:1,line:0,linux:2,list:[0,3,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:0,manual:0,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,3,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:0,modul:[],more:[0,4],most:1,move:1,movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],name:0,necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onli:2,open:1,option:[0,1,4],origin:4,other:0,out:[3,4],output:1,packag:2,page:[],pip:2,pleas:6,possibl:1,print:[1,3,4],project:1,properli:6,python:0,quennevil:3,quickstart:0,quit:1,raw:1,recod:0,recur:1,referenc:1,repair:[0,6],report:1,repositori:1,requir:2,resolut:0,run:[1,6],search:[],see:0,segfault:1,sei:1,separ:[3,4],serv:1,some:1,sourc:[0,1],step:1,subsd:6,substandard:6,suggest:1,synopsi:0,take:1,thi:2,too:1,tool:0,track:1,txt:[2,3,4],type:1,uhd:[3,4],unintend:6,until:6,updat:1,use:[3,4,6],used:[1,6],using:[1,4,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video2:3,video:[0,1,3,4,6],want:1,warn:0,when:[1,6],wich:1,without:0,wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,Use:5,also:3,author:3,bug:1,descript:3,document:0,encod:1,error:1,exampl:3,ffmpeg:[1,2],from:2,github:2,indic:[],instal:2,issu:1,manual:3,mediacur:0,name:3,option:3,other:1,quickstart:4,repair:1,see:3,synopsi:3,tabl:[],warn:6,welcom:0}})

docsource/build/html/usage/manual.html

@@ -36,6 +36,14 @@
             
   <div class="section" id="manual">
 <h1>Manual<a class="headerlink" href="#manual" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="name">
+<h2>Name<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>MediaCurator</p>
+</div></blockquote>
+</div>
+<div class="section" id="synopsis">
+<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py <span class="o">[</span>list,convert<span class="o">]</span> <span class="o">[</span>-del<span class="o">]</span>
     <span class="o">[</span>-in:any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid<span class="o">]</span>
     <span class="o">[</span>-filters:fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv<span class="o">]</span>
@@ -44,6 +52,39 @@
     <span class="o">[</span>-dir/-files:<span class="s2">&quot;/mnt/media/&quot;</span>,,<span class="s2">&quot;/mnt/media2/&quot;</span><span class="o">]</span>
 </pre></div>
 </div>
+</div>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="options">
+<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
+<p>list</p>
+<p>convert</p>
+<p>-del:</p>
+<dl class="simple">
+<dt>-in:</dt><dd><p>[any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]</p>
+</dd>
+<dt>-filters:</dt><dd><p>[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]</p>
+</dd>
+<dt>-out:</dt><dd><p>[mkv/mp4,x265/av1]</p>
+</dd>
+<dt>-print:</dt><dd><p>[list,formated,verbose]</p>
+</dd>
+<dt>-dir:</dt><dd><p>[“/mnt/media/”,,”/mnt/media2/”]</p>
+</dd>
+<dt>-files:</dt><dd><p>[“/mnt/media/video.avi”,,”/mnt/media2/video2.mp4”]</p>
+</dd>
+</dl>
+</div>
+<div class="section" id="examples">
+<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="see-also">
+<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="author">
+<h2>Author<a class="headerlink" href="#author" title="Permalink to this headline">¶</a></h2>
+<p>Fabrice Quenneville</p>
 <p><strong>for multiple files or filenames use double comma separated values “,,”</strong></p>
 <p>default options are:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>-in:any
@@ -58,6 +99,9 @@
 ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
 </pre></div>
 </div>
+<p>Synopsis</p>
+<p>Description</p>
+</div>
 </div>
 
 
@@ -82,9 +126,19 @@
 <h3>Navigation</h3>
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Manual</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Manual</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#name">Name</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#description">Description</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#see-also">See Also</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#author">Author</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
 </ul>

docsource/build/html/usage/quickstart.html

@@ -16,7 +16,7 @@
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Use cases" href="use_cases.html" />
+    <link rel="next" title="Manual" href="manual.html" />
     <link rel="prev" title="Installation" href="installation.html" />
    
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -53,11 +53,14 @@
 </pre></div>
 </div>
 <p>Examples:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py list -filters:old -print:formated -dir:/mnt/media/ &gt;&gt; ../medlist.txt
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># List all videos with old codec in formated format</span>
+./curator.py list -filters:old -print:formated -dir:/mnt/media/ &gt;&gt; ../medlist.txt
+<span class="c1"># Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals</span>
 ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:<span class="s2">&quot;/mnt/media/Movies/&quot;</span>
 ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
 </pre></div>
 </div>
+<p>More examples in <a class="reference internal" href="use_cases.html"><span class="doc">Use cases</span></a></p>
 </div>
 
 
@@ -82,8 +85,10 @@
 <h3>Navigation</h3>
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual.html">Manual</a></li>
 <li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
 </ul>
@@ -93,7 +98,7 @@
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
       <li>Previous: <a href="installation.html" title="previous chapter">Installation</a></li>
-      <li>Next: <a href="use_cases.html" title="next chapter">Use cases</a></li>
+      <li>Next: <a href="manual.html" title="next chapter">Manual</a></li>
   </ul></li>
 </ul>
 </div>

docsource/build/html/usage/use_cases.html

@@ -17,7 +17,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Errors" href="errors.html" />
-    <link rel="prev" title="Quickstart" href="quickstart.html" />
+    <link rel="prev" title="Manual" href="manual.html" />
    
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
   
@@ -60,8 +60,10 @@
 <h3>Navigation</h3>
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual.html">Manual</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
 </ul>
@@ -70,7 +72,7 @@
 <h3>Related Topics</h3>
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="quickstart.html" title="previous chapter">Quickstart</a></li>
+      <li>Previous: <a href="manual.html" title="previous chapter">Manual</a></li>
       <li>Next: <a href="errors.html" title="next chapter">Errors</a></li>
   </ul></li>
 </ul>

docsource/source/_build/html/_sources/usage/manual.rst.txt

@@ -2,6 +2,14 @@
 Manual
 ======
 
+Name
+----
+
+    MediaCurator
+
+Synopsis
+--------
+
 .. code-block:: bash
 
     ./curator.py [list,convert] [-del]
@@ -11,6 +19,48 @@ Manual
         [-print:list,formated,verbose]
         [-dir/-files:"/mnt/media/",,"/mnt/media2/"]
 
+Description
+-----------
+
+Options
+-------
+
+list
+
+convert
+
+-del:
+
+-in:
+    [any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]
+-filters:
+    [fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]
+-out:
+    [mkv/mp4,x265/av1]
+-print:
+    [list,formated,verbose]
+-dir:
+    ["/mnt/media/",,"/mnt/media2/"]
+-files:
+    ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"]
+
+Examples
+--------
+
+
+See Also
+--------
+
+Author
+------
+
+Fabrice Quenneville
+
+
+
+
+
+
 **for multiple files or filenames use double comma separated values ",,"**
 
 default options are:
@@ -29,3 +79,13 @@ Examples:
     ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
     ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
     ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
+
+
+
+Synopsis
+
+
+
+Description
+
+

docsource/source/_build/html/_sources/usage/quickstart.rst.txt

@@ -26,6 +26,10 @@ Examples:
 
 .. code-block:: bash
 
+    # List all videos with old codec in formated format
     ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
+    # Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals
     ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
     ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
+
+More examples in :doc:`use_cases`

docsource/source/_build/html/_sources/usage/use_cases.rst.txt

@@ -1,4 +1,3 @@
-
 =========
 Use cases
 =========

docsource/source/_build/html/_sources/usage/warnings.rst.txt

@@ -5,3 +5,41 @@ Warnings
 Before using the delete feature please run a few dry runs to get acquainted with MediaCurator as you it can irrirreparably damage your media library when not used properly.
 
 When using the -del flag here is the expected behavior:
+
+To delete all non-hd videos in a folder:
+
+.. code-block:: bash
+
+    ./curator.py list -del -filters:lowres  -dir/-files:"/mnt/media/"
+
+To delete all substandard videos in a folder:
+
+.. code-block:: bash
+
+    ./curator.py list -del -filters:subsd  -dir/-files:"/mnt/media/"
+
+.. image:: ../_static/Screenshot-delete.png
+    :width: 600
+    :alt: Deleting videos
+
+To delete all videos in a folder with encoding errors:
+
+.. code-block:: bash
+
+    ./curator.py list -del -filters:fferror  -dir/-files:"/mnt/media/"
+
+To convert (repair) then delete all videos in a folder with encoding errors:
+
+.. code-block:: bash
+
+    ./curator.py convert -del -filters:fferror  -dir/-files:"/mnt/media/"
+
+To delete all videos in a folder:
+
+.. code-block:: bash
+
+    ./curator.py list -del -filters:lowres  -dir/-files:"/mnt/media/"
+
+All these commands can have valuable use but are irrecoverable if done unintended.
+
+Again, please run a few dry runs until you are acquainted with MediaCurator.

docsource/source/_build/html/index.html

@@ -52,7 +52,16 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage/manual.html">Manual</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage/manual.html">Manual</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#name">Name</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#synopsis">Synopsis</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#description">Description</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#options">Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#see-also">See Also</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#author">Author</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="usage/errors.html#repairable-encoding-errors">Repairable encoding errors</a></li>

docsource/source/_build/html/searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],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":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":[3,4],"720p":[3,4],"case":0,"default":[3,4],"try":1,"while":1,For:2,The:0,Use:0,acquaint:6,activ:1,after:1,again:1,all:0,also:1,ani:[3,4],audio:1,av1:[0,3,4],avi:[3,4],base:0,batch:0,befor:6,behavior:6,big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:0,com:2,comma:[3,4],command:0,content:0,convert:[0,3,4],curat:[3,4],damag:[1,6],databas:0,decod:1,del:[3,4,6],delet:6,depend:1,detect:1,dir:[3,4],distribut:[1,2],don:1,doubl:[3,4],download:2,dry:6,encod:0,error:0,exampl:[1,3,4],expect:6,experi:1,extent:0,fabquennevil:2,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4],ffmpeg:0,file:[3,4],filenam:[3,4],filter:[0,3,4],find:0,flag:6,flv:[3,4],format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,header:1,here:[1,6],http:2,index:[],inform:[0,1],instal:0,irrirrepar:6,issu:0,its:1,latest:1,librari:6,like:1,line:0,linux:2,list:[0,3,4],lowr:[3,4],m4v:[3,4],mai:1,manag:0,manual:0,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4],modern:0,modul:[],more:0,most:1,move:1,movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],necessarli:1,next:1,now:2,occur:1,old:[1,3,4],onli:2,open:1,option:[1,3,4],other:0,out:[3,4],output:1,packag:2,page:[],pip:2,pleas:6,possibl:1,print:[1,3,4],project:1,properli:6,python:0,quickstart:0,quit:1,raw:1,recod:0,recur:1,referenc:1,repair:0,report:1,repositori:1,requir:2,resolut:0,run:[1,6],search:[],segfault:1,sei:1,separ:[3,4],serv:1,some:1,sourc:[0,1],step:1,suggest:1,take:1,thi:2,too:1,tool:0,track:1,txt:[2,3,4],type:1,uhd:[3,4],updat:1,use:[3,4],used:[1,6],using:[1,6],valu:[3,4],verbos:[1,3,4],veri:1,version:1,vid:[3,4],video:[0,1],want:1,warn:0,when:[1,6],wich:1,without:0,wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,For:[],Use:5,bug:1,distribut:[],document:0,download:[],encod:1,error:1,ffmpeg:[1,2],from:2,github:2,gnu:[],indic:[],instal:2,issu:1,linux:[],manual:3,mediacur:0,now:[],onli:[],other:1,packag:[],quickstart:4,repair:1,requir:[],tabl:[],thi:[],warn:6,welcom:0,work:[]}})
+Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/manual","usage/quickstart","usage/use_cases","usage/warnings"],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":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/manual.rst","usage/quickstart.rst","usage/use_cases.rst","usage/warnings.rst"],objects:{},objnames:{},objtypes:{},terms:{"1080p":[3,4],"720p":[3,4],"case":[0,4],"default":[3,4],"try":1,"while":1,For:2,The:0,Use:[0,4],acquaint:6,activ:1,after:1,again:[1,6],all:[0,4,6],also:[0,1],ani:[3,4],audio:1,author:0,av1:[0,3,4],avi:[3,4],base:0,batch:0,befor:6,behavior:6,big:1,big_valu:1,bug:0,can:[0,1,6],chapter:1,clean:1,clone:2,code:0,codec:[0,4],com:2,comma:[3,4],command:[0,6],content:0,convert:[0,3,4,6],curat:[3,4,6],damag:[1,6],databas:0,decod:1,del:[3,4,6],delet:[4,6],depend:1,descript:0,detect:1,dir:[3,4,6],distribut:[1,2],don:1,done:6,doubl:[3,4],download:2,dry:6,encod:[0,6],error:[0,6],exampl:[0,1,4],expect:6,experi:1,extent:0,fabquennevil:2,fabric:3,face:1,failur:1,featur:[1,6],feel:1,few:[1,6],fferror:[3,4,6],ffmpeg:0,file:[3,4,6],filenam:[3,4],filter:[0,3,4,6],find:0,flag:6,flv:[3,4],folder:6,format:[3,4],found:[0,1],frame:1,free:1,from:0,get:6,git:2,github:[0,1],gnu:2,happen:1,have:6,header:1,here:[1,6],http:2,index:[],inform:[0,1],instal:0,irrecover:6,irrirrepar:6,issu:0,its:1,latest:1,librari:6,like:1,line:0,linux:2,list:[0,3,4,6],lowr:[3,4,6],m4v:[3,4],mai:1,manag:0,manual:0,media2:[3,4],media:[0,3,4,6],mediacur:[1,2,3,6],medlist:[3,4],miss:1,mkv:[3,4],mnt:[3,4,6],modern:0,modul:[],more:[0,4],most:1,move:1,movi:[3,4],mp4:[3,4],mpeg4:[3,4],mpeg:[1,3,4],mpg:[3,4],multipl:[3,4],name:0,necessarli:1,next:1,non:6,now:2,occur:1,old:[1,3,4],onli:2,open:1,option:[0,1,4],origin:4,other:0,out:[3,4],output:1,packag:2,page:[],pip:2,pleas:6,possibl:1,print:[1,3,4],project:1,properli:6,python:0,quennevil:3,quickstart:0,quit:1,raw:1,recod:0,recur:1,referenc:1,repair:[0,6],report:1,repositori:1,requir:2,resolut:0,run:[1,6],search:[],see:0,segfault:1,sei:1,separ:[3,4],serv:1,some:1,sourc:[0,1],step:1,subsd:6,substandard:6,suggest:1,synopsi:0,take:1,thi:2,too:1,tool:0,track:1,txt:[2,3,4],type:1,uhd:[3,4],unintend:6,until:6,updat:1,use:[3,4,6],used:[1,6],using:[1,4,6],valu:[3,4],valuabl:6,verbos:[1,3,4],veri:1,version:1,vid:[3,4],video2:3,video:[0,1,3,4,6],want:1,warn:0,when:[1,6],wich:1,without:0,wmv3:[3,4],wmv:[3,4],work:2,x264:[3,4],x265:[0,3,4],you:[1,6],your:[1,6]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Manual","Quickstart","Use cases","Warnings"],titleterms:{"case":5,For:[],Use:5,also:3,author:3,bug:1,descript:3,distribut:[],document:0,download:[],encod:1,error:1,exampl:3,ffmpeg:[1,2],from:2,github:2,gnu:[],indic:[],instal:2,issu:1,linux:[],manual:3,mediacur:0,name:3,now:[],onli:[],option:3,other:1,packag:[],quickstart:4,repair:1,requir:[],see:3,synopsi:3,tabl:[],thi:[],warn:6,welcom:0,work:[]}})

docsource/source/_build/html/usage/manual.html

@@ -36,6 +36,14 @@
             
   <div class="section" id="manual">
 <h1>Manual<a class="headerlink" href="#manual" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="name">
+<h2>Name<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>MediaCurator</p>
+</div></blockquote>
+</div>
+<div class="section" id="synopsis">
+<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py <span class="o">[</span>list,convert<span class="o">]</span> <span class="o">[</span>-del<span class="o">]</span>
     <span class="o">[</span>-in:any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid<span class="o">]</span>
     <span class="o">[</span>-filters:fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv<span class="o">]</span>
@@ -44,6 +52,39 @@
     <span class="o">[</span>-dir/-files:<span class="s2">&quot;/mnt/media/&quot;</span>,,<span class="s2">&quot;/mnt/media2/&quot;</span><span class="o">]</span>
 </pre></div>
 </div>
+</div>
+<div class="section" id="description">
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="options">
+<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
+<p>list</p>
+<p>convert</p>
+<p>-del:</p>
+<dl class="simple">
+<dt>-in:</dt><dd><p>[any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]</p>
+</dd>
+<dt>-filters:</dt><dd><p>[fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]</p>
+</dd>
+<dt>-out:</dt><dd><p>[mkv/mp4,x265/av1]</p>
+</dd>
+<dt>-print:</dt><dd><p>[list,formated,verbose]</p>
+</dd>
+<dt>-dir:</dt><dd><p>[“/mnt/media/”,,”/mnt/media2/”]</p>
+</dd>
+<dt>-files:</dt><dd><p>[“/mnt/media/video.avi”,,”/mnt/media2/video2.mp4”]</p>
+</dd>
+</dl>
+</div>
+<div class="section" id="examples">
+<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="see-also">
+<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="author">
+<h2>Author<a class="headerlink" href="#author" title="Permalink to this headline">¶</a></h2>
+<p>Fabrice Quenneville</p>
 <p><strong>for multiple files or filenames use double comma separated values “,,”</strong></p>
 <p>default options are:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>-in:any
@@ -58,6 +99,9 @@
 ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
 </pre></div>
 </div>
+<p>Synopsis</p>
+<p>Description</p>
+</div>
 </div>
 
 
@@ -85,7 +129,16 @@
 <li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Manual</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Manual</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#name">Name</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#description">Description</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#see-also">See Also</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#author">Author</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
 </ul>

docsource/source/_build/html/usage/quickstart.html

@@ -53,11 +53,14 @@
 </pre></div>
 </div>
 <p>Examples:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py list -filters:old -print:formated -dir:/mnt/media/ &gt;&gt; ../medlist.txt
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># List all videos with old codec in formated format</span>
+./curator.py list -filters:old -print:formated -dir:/mnt/media/ &gt;&gt; ../medlist.txt
+<span class="c1"># Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals</span>
 ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:<span class="s2">&quot;/mnt/media/Movies/&quot;</span>
 ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
 </pre></div>
 </div>
+<p>More examples in <a class="reference internal" href="use_cases.html"><span class="doc">Use cases</span></a></p>
 </div>
 
 

docsource/source/_build/html/usage/use_cases.html

@@ -17,7 +17,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Errors" href="errors.html" />
-    <link rel="prev" title="Quickstart" href="quickstart.html" />
+    <link rel="prev" title="Manual" href="manual.html" />
    
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
   
@@ -60,8 +60,10 @@
 <h3>Navigation</h3>
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual.html">Manual</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
 </ul>
@@ -70,7 +72,7 @@
 <h3>Related Topics</h3>
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="quickstart.html" title="previous chapter">Quickstart</a></li>
+      <li>Previous: <a href="manual.html" title="previous chapter">Manual</a></li>
       <li>Next: <a href="errors.html" title="next chapter">Errors</a></li>
   </ul></li>
 </ul>

docsource/source/_build/html/usage/warnings.html

@@ -38,6 +38,29 @@
 <h1>Warnings<a class="headerlink" href="#warnings" title="Permalink to this headline">¶</a></h1>
 <p>Before using the delete feature please run a few dry runs to get acquainted with MediaCurator as you it can irrirreparably damage your media library when not used properly.</p>
 <p>When using the -del flag here is the expected behavior:</p>
+<p>To delete all non-hd videos in a folder:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py list -del -filters:lowres  -dir/-files:<span class="s2">&quot;/mnt/media/&quot;</span>
+</pre></div>
+</div>
+<p>To delete all substandard videos in a folder:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py list -del -filters:subsd  -dir/-files:<span class="s2">&quot;/mnt/media/&quot;</span>
+</pre></div>
+</div>
+<a class="reference internal image-reference" href="../_images/Screenshot-delete.png"><img alt="Deleting videos" src="../_images/Screenshot-delete.png" style="width: 600px;" /></a>
+<p>To delete all videos in a folder with encoding errors:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py list -del -filters:fferror  -dir/-files:<span class="s2">&quot;/mnt/media/&quot;</span>
+</pre></div>
+</div>
+<p>To convert (repair) then delete all videos in a folder with encoding errors:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py convert -del -filters:fferror  -dir/-files:<span class="s2">&quot;/mnt/media/&quot;</span>
+</pre></div>
+</div>
+<p>To delete all videos in a folder:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./curator.py list -del -filters:lowres  -dir/-files:<span class="s2">&quot;/mnt/media/&quot;</span>
+</pre></div>
+</div>
+<p>All these commands can have valuable use but are irrecoverable if done unintended.</p>
+<p>Again, please run a few dry runs until you are acquainted with MediaCurator.</p>
 </div>
 
 

docsource/source/usage/manual.rst

@@ -2,6 +2,14 @@
 Manual
 ======
 
+Name
+----
+
+    MediaCurator
+
+Synopsis
+--------
+
 .. code-block:: bash
 
     ./curator.py [list,convert] [-del]
@@ -11,6 +19,48 @@ Manual
         [-print:list,formated,verbose]
         [-dir/-files:"/mnt/media/",,"/mnt/media2/"]
 
+Description
+-----------
+
+Options
+-------
+
+list
+
+convert
+
+-del:
+
+-in:
+    [any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid]
+-filters:
+    [fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv]
+-out:
+    [mkv/mp4,x265/av1]
+-print:
+    [list,formated,verbose]
+-dir:
+    ["/mnt/media/",,"/mnt/media2/"]
+-files:
+    ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"]
+
+Examples
+--------
+
+
+See Also
+--------
+
+Author
+------
+
+Fabrice Quenneville
+
+
+
+
+
+
 **for multiple files or filenames use double comma separated values ",,"**
 
 default options are:
@@ -29,3 +79,13 @@ Examples:
     ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
     ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
     ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
+
+
+
+Synopsis
+
+
+
+Description
+
+

docsource/source/usage/quickstart.rst

@@ -26,6 +26,10 @@ Examples:
 
 .. code-block:: bash
 
+    # List all videos with old codec in formated format
     ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
+    # Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals
     ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
     ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
+
+More examples in :doc:`use_cases`

docsource/source/usage/use_cases.rst

@@ -1,4 +1,3 @@
-
 =========
 Use cases
 =========