Working on doc quickstart

docs/_sources/index.rst.txt

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

docs/_sources/usage/quickstart.rst.txt

@@ -1,4 +1,31 @@
-
 ==========
 Quickstart
 ==========
+
+.. 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

@@ -62,6 +62,7 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <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/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

@@ -49,6 +49,7 @@
 <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-from-github">Install from GitHub</a></li>
 </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/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>
@@ -78,6 +79,7 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <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/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

@@ -81,6 +81,7 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <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/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/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/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,The:0,Use:0,all:0,audio:1,av1:0,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,command:0,content:0,damag:1,databas:0,decod:1,distribut:2,download:2,error:0,extent:0,fabquennevil:2,ffmpeg:0,filter:0,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:0,manag:0,media:0,mediacur:2,miss:1,modern:0,modul:[],more:0,mpeg:1,now:2,onli:2,packag:2,page:[],pip:2,python:0,quickstart:[],recod:0,referenc:1,requir:2,search:[],sei:1,sourc:0,thi:2,too:1,tool:0,track:1,txt:2,type:1,video:0,without:0,work:2,x265:0},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Use cases"],titleterms:{"case":3,Use:3,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:[],tabl:[],welcom:0}})
+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,"while":1,For:2,The:0,Use:0,all:0,ani:3,audio:1,av1:[0,3],avi:3,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,comma:3,command:0,content:0,convert:3,curat:3,damag:1,databas:0,decod:1,del:3,dir:3,distribut:2,doubl:3,download:2,error:0,exampl:3,extent:0,fabquennevil:2,fferror:3,ffmpeg:0,file:3,filenam:3,filter:[0,3],flv:3,format:3,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:[0,3],lowr:3,m4v:3,manag:0,media2:3,media:[0,3],mediacur:2,medlist:3,miss:1,mkv:3,mnt:3,modern:0,modul:[],more:0,movi:3,mp4:3,mpeg4:3,mpeg:[1,3],mpg:3,multipl:3,now:2,old:3,onli:2,option:3,out:3,packag:2,page:[],pip:2,print:3,python:0,quickstart:0,recod:0,referenc:1,requir:2,search:[],sei:1,separ:3,sourc:0,thi:2,too:1,tool:0,track:1,txt:[2,3],type:1,uhd:3,use:3,valu:3,verbos:3,vid:3,video:0,without:0,wmv3:3,wmv:3,work:2,x264:3,x265:[0,3]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:3,tabl:[],welcom:0}})

docs/usage/quickstart.html

@@ -36,6 +36,28 @@
             
   <div class="section" id="quickstart">
 <h1>Quickstart<a class="headerlink" href="#quickstart" 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>
 
 

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

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

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

@@ -1,4 +1,31 @@
-
 ==========
 Quickstart
 ==========
+
+.. 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

@@ -62,6 +62,7 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <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/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

@@ -49,6 +49,7 @@
 <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-from-github">Install from GitHub</a></li>
 </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/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>
@@ -78,6 +79,7 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <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/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

@@ -81,6 +81,7 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <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/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/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/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,The:0,Use:0,all:0,audio:1,av1:0,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,command:0,content:0,damag:1,databas:0,decod:1,distribut:2,download:2,error:0,extent:0,fabquennevil:2,ffmpeg:0,filter:0,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:0,manag:0,media:0,mediacur:2,miss:1,modern:0,modul:[],more:0,mpeg:1,now:2,onli:2,packag:2,page:[],pip:2,python:0,quickstart:[],recod:0,referenc:1,requir:2,search:[],sei:1,sourc:0,thi:2,too:1,tool:0,track:1,txt:2,type:1,video:0,without:0,work:2,x265:0},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Use cases"],titleterms:{"case":3,Use:3,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:[],tabl:[],welcom:0}})
+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,"while":1,For:2,The:0,Use:0,all:0,ani:3,audio:1,av1:[0,3],avi:3,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,comma:3,command:0,content:0,convert:3,curat:3,damag:1,databas:0,decod:1,del:3,dir:3,distribut:2,doubl:3,download:2,error:0,exampl:3,extent:0,fabquennevil:2,fferror:3,ffmpeg:0,file:3,filenam:3,filter:[0,3],flv:3,format:3,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:[0,3],lowr:3,m4v:3,manag:0,media2:3,media:[0,3],mediacur:2,medlist:3,miss:1,mkv:3,mnt:3,modern:0,modul:[],more:0,movi:3,mp4:3,mpeg4:3,mpeg:[1,3],mpg:3,multipl:3,now:2,old:3,onli:2,option:3,out:3,packag:2,page:[],pip:2,print:3,python:0,quickstart:0,recod:0,referenc:1,requir:2,search:[],sei:1,separ:3,sourc:0,thi:2,too:1,tool:0,track:1,txt:[2,3],type:1,uhd:3,use:3,valu:3,verbos:3,vid:3,video:0,without:0,wmv3:3,wmv:3,work:2,x264:3,x265:[0,3]},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:3,tabl:[],welcom:0}})

docsource/build/html/usage/quickstart.html

@@ -36,6 +36,28 @@
             
   <div class="section" id="quickstart">
 <h1>Quickstart<a class="headerlink" href="#quickstart" 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>
 
 

docsource/source/index.rst

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

docsource/source/usage/quickstart.rst

@@ -0,0 +1,31 @@
+==========
+Quickstart
+==========
+
+.. 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/