Working on docs

README.md

@@ -6,7 +6,7 @@ MediaCurator is a Python command line tool to manage a media database.
 
 ## Documentation
 
-The documentation is available [here](https://fabquenneville.github.io/MediaCurator/)
+The documentation is available on the following [link](https://fabquenneville.github.io/MediaCurator/)
 
 ## Usage
 ./curator.py [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/-files:"/mnt/media/",,"/mnt/media2/"]

docs/_sources/index.rst.txt

@@ -21,6 +21,7 @@ The source code can be found on `GitHub <https://github.com/fabquenneville/Media
 
    usage/installation
    usage/quickstart
+   usage/manual
    usage/use_cases
    usage/errors
 

docs/_sources/usage/errors.rst.txt

@@ -26,7 +26,8 @@ While using FFmpeg depending on your version you may also face other errors like
 
 If that happens there are a few steps you can take:
 
-* Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories
+
+* `Update FFmpeg <https://ffmpeg.org/download.html>`_ to its latest version as it is a very active project and most distributions serve old versions in their repositories
 * Run MediaCurator with the verbose print option wich will print the raw FFmpeg output
 * Try again: In my experience some errors don't necessarly recur...
 

docs/_sources/usage/manual.rst.txt

@@ -0,0 +1,31 @@
+======
+Manual
+======
+
+.. code-block:: bash
+
+    ./curator.py [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/-files:"/mnt/media/",,"/mnt/media2/"]
+
+**for multiple files or filenames use double comma separated values ",,"**
+
+default options are:
+
+.. code-block:: bash
+
+    -in:any
+    -filters:
+    -out:mkv,x265
+    -print:list
+
+Examples:
+
+.. code-block:: bash
+
+    ./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/

docs/genindex.html

@@ -63,6 +63,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></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/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docs/index.html

@@ -51,6 +51,7 @@
 </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/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>
@@ -86,6 +87,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></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/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docs/search.html

@@ -82,6 +82,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></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/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docs/searchindex.js

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

docs/usage/errors.html

@@ -55,7 +55,7 @@
 <p>While using FFmpeg depending on your version you may also face other errors like segfaults. MediaCurator will also print information when that occurs and move on to the next video after cleaning up after failure.</p>
 <p>If that happens there are a few steps you can take:</p>
 <ul class="simple">
-<li><p>Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories</p></li>
+<li><p><a class="reference external" href="https://ffmpeg.org/download.html">Update FFmpeg</a> to its latest version as it is a very active project and most distributions serve old versions in their repositories</p></li>
 <li><p>Run MediaCurator with the verbose print option wich will print the raw FFmpeg output</p></li>
 <li><p>Try again: In my experience some errors don’t necessarly recur…</p></li>
 </ul>
@@ -90,6 +90,7 @@
 <ul class="current">
 <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"><a class="reference internal" href="use_cases.html">Use cases</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Errors</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#repairable-encoding-errors">Repairable encoding errors</a></li>

docs/usage/manual.html

@@ -0,0 +1,139 @@
+
+<!DOCTYPE html>
+
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Manual &#8212; MediaCurator  documentation</title>
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+    <script src="../_static/jquery.js"></script>
+    <script src="../_static/underscore.js"></script>
+    <script src="../_static/doctools.js"></script>
+    <script src="../_static/language_data.js"></script>
+    <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="prev" title="Quickstart" href="quickstart.html" />
+   
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  
+  
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+  </head><body>
+  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          
+
+          <div class="body" role="main">
+            
+  <div class="section" id="manual">
+<h1>Manual<a class="headerlink" href="#manual" title="Permalink to this headline">¶</a></h1>
+<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>
+    <span class="o">[</span>-out:mkv/mp4,x265/av1<span class="o">]</span>
+    <span class="o">[</span>-print:list,formated,verbose<span class="o">]</span>
+    <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>
+<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
+-filters:
+-out:mkv,x265
+-print:list
+</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
+./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>
+</div>
+
+
+          </div>
+          
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+            <p class="logo"><a href="../index.html">
+              <img class="logo" src="../_static/mclogo4x.png" alt="Logo"/>
+            </a></p>
+<h1 class="logo"><a href="../index.html">MediaCurator</a></h1>
+
+
+
+
+
+
+
+
+<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="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"><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>
+
+<div class="relations">
+<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>Next: <a href="use_cases.html" title="next chapter">Use cases</a></li>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>$('#searchbox').show(0);</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2020, Fabrice Quenneville.
+      
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.1</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
+      
+      |
+      <a href="../_sources/usage/manual.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+    
+
+    
+  </body>
+</html>

docsource/build/html/_sources/index.rst.txt

@@ -21,6 +21,7 @@ The source code can be found on `GitHub <https://github.com/fabquenneville/Media
 
    usage/installation
    usage/quickstart
+   usage/manual
    usage/use_cases
    usage/errors
 

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

@@ -26,7 +26,8 @@ While using FFmpeg depending on your version you may also face other errors like
 
 If that happens there are a few steps you can take:
 
-* Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories
+
+* `Update FFmpeg <https://ffmpeg.org/download.html>`_ to its latest version as it is a very active project and most distributions serve old versions in their repositories
 * Run MediaCurator with the verbose print option wich will print the raw FFmpeg output
 * Try again: In my experience some errors don't necessarly recur...
 

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

@@ -0,0 +1,31 @@
+======
+Manual
+======
+
+.. code-block:: bash
+
+    ./curator.py [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/-files:"/mnt/media/",,"/mnt/media2/"]
+
+**for multiple files or filenames use double comma separated values ",,"**
+
+default options are:
+
+.. code-block:: bash
+
+    -in:any
+    -filters:
+    -out:mkv,x265
+    -print:list
+
+Examples:
+
+.. code-block:: bash
+
+    ./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/

docsource/build/html/genindex.html

@@ -63,6 +63,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></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/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docsource/build/html/index.html

@@ -51,6 +51,7 @@
 </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/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>
@@ -86,6 +87,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></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/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docsource/build/html/search.html

@@ -82,6 +82,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></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/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docsource/build/html/searchindex.js

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

docsource/build/html/usage/errors.html

@@ -55,7 +55,7 @@
 <p>While using FFmpeg depending on your version you may also face other errors like segfaults. MediaCurator will also print information when that occurs and move on to the next video after cleaning up after failure.</p>
 <p>If that happens there are a few steps you can take:</p>
 <ul class="simple">
-<li><p>Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories</p></li>
+<li><p><a class="reference external" href="https://ffmpeg.org/download.html">Update FFmpeg</a> to its latest version as it is a very active project and most distributions serve old versions in their repositories</p></li>
 <li><p>Run MediaCurator with the verbose print option wich will print the raw FFmpeg output</p></li>
 <li><p>Try again: In my experience some errors don’t necessarly recur…</p></li>
 </ul>
@@ -90,6 +90,7 @@
 <ul class="current">
 <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"><a class="reference internal" href="use_cases.html">Use cases</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Errors</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#repairable-encoding-errors">Repairable encoding errors</a></li>

docsource/build/html/usage/manual.html

@@ -0,0 +1,139 @@
+
+<!DOCTYPE html>
+
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Manual &#8212; MediaCurator  documentation</title>
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+    <script src="../_static/jquery.js"></script>
+    <script src="../_static/underscore.js"></script>
+    <script src="../_static/doctools.js"></script>
+    <script src="../_static/language_data.js"></script>
+    <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="prev" title="Quickstart" href="quickstart.html" />
+   
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  
+  
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+  </head><body>
+  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          
+
+          <div class="body" role="main">
+            
+  <div class="section" id="manual">
+<h1>Manual<a class="headerlink" href="#manual" title="Permalink to this headline">¶</a></h1>
+<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>
+    <span class="o">[</span>-out:mkv/mp4,x265/av1<span class="o">]</span>
+    <span class="o">[</span>-print:list,formated,verbose<span class="o">]</span>
+    <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>
+<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
+-filters:
+-out:mkv,x265
+-print:list
+</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
+./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>
+</div>
+
+
+          </div>
+          
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+            <p class="logo"><a href="../index.html">
+              <img class="logo" src="../_static/mclogo4x.png" alt="Logo"/>
+            </a></p>
+<h1 class="logo"><a href="../index.html">MediaCurator</a></h1>
+
+
+
+
+
+
+
+
+<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="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"><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>
+
+<div class="relations">
+<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>Next: <a href="use_cases.html" title="next chapter">Use cases</a></li>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>$('#searchbox').show(0);</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2020, Fabrice Quenneville.
+      
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.1</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
+      
+      |
+      <a href="../_sources/usage/manual.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+    
+
+    
+  </body>
+</html>

docsource/source/index.rst

@@ -21,6 +21,7 @@ The source code can be found on `GitHub <https://github.com/fabquenneville/Media
 
    usage/installation
    usage/quickstart
+   usage/manual
    usage/use_cases
    usage/errors
 

docsource/source/usage/errors.rst

@@ -26,7 +26,8 @@ While using FFmpeg depending on your version you may also face other errors like
 
 If that happens there are a few steps you can take:
 
-* Update FFmpeg to its latest version as it is a very active project and most distributions serve old versions in their repositories
+
+* `Update FFmpeg <https://ffmpeg.org/download.html>`_ to its latest version as it is a very active project and most distributions serve old versions in their repositories
 * Run MediaCurator with the verbose print option wich will print the raw FFmpeg output
 * Try again: In my experience some errors don't necessarly recur...
 

docsource/source/usage/manual.rst

@@ -0,0 +1,31 @@
+======
+Manual
+======
+
+.. code-block:: bash
+
+    ./curator.py [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/-files:"/mnt/media/",,"/mnt/media2/"]
+
+**for multiple files or filenames use double comma separated values ",,"**
+
+default options are:
+
+.. code-block:: bash
+
+    -in:any
+    -filters:
+    -out:mkv,x265
+    -print:list
+
+Examples:
+
+.. code-block:: bash
+
+    ./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/