From 097789bdf07adae60071be0f1014ec01fa3826b4 Mon Sep 17 00:00:00 2001 From: Fabrice Quenneville Date: Mon, 14 Dec 2020 01:38:06 -0500 Subject: [PATCH] Updated docs --- docs/_sources/usage/installation.rst.txt | 2 +- docs/_sources/usage/manual.rst.txt | 12 +++++----- docs/_sources/usage/quickstart.rst.txt | 8 +++---- docs/_sources/usage/use_cases.rst.txt | 22 +++++++++--------- docs/_sources/usage/warnings.rst.txt | 10 ++++---- docs/objects.inv | 2 +- docs/searchindex.js | 2 +- docs/usage/installation.html | 8 ++++--- docs/usage/manual.html | 12 +++++----- docs/usage/quickstart.html | 8 +++---- docs/usage/use_cases.html | 22 +++++++++--------- docs/usage/warnings.html | 10 ++++---- docsource/build/doctrees/environment.pickle | Bin 25275 -> 25510 bytes .../build/doctrees/usage/installation.doctree | Bin 4579 -> 4597 bytes docsource/build/doctrees/usage/manual.doctree | Bin 24846 -> 24858 bytes .../build/doctrees/usage/quickstart.doctree | Bin 5413 -> 5421 bytes .../build/doctrees/usage/use_cases.doctree | Bin 19516 -> 19538 bytes .../build/doctrees/usage/warnings.doctree | Bin 6003 -> 6013 bytes .../html/_sources/usage/installation.rst.txt | 2 +- .../build/html/_sources/usage/manual.rst.txt | 12 +++++----- .../html/_sources/usage/quickstart.rst.txt | 8 +++---- .../html/_sources/usage/use_cases.rst.txt | 22 +++++++++--------- .../html/_sources/usage/warnings.rst.txt | 10 ++++---- docsource/build/html/objects.inv | 2 +- docsource/build/html/searchindex.js | 2 +- docsource/build/html/usage/installation.html | 8 ++++--- docsource/build/html/usage/manual.html | 12 +++++----- docsource/build/html/usage/quickstart.html | 8 +++---- docsource/build/html/usage/use_cases.html | 22 +++++++++--------- docsource/build/html/usage/warnings.html | 10 ++++---- docsource/source/usage/manual.rst | 2 +- mediacurator/curator.py | 2 ++ mediacurator/library/tools.py | 4 ++++ 33 files changed, 127 insertions(+), 117 deletions(-) diff --git a/docs/_sources/usage/installation.rst.txt b/docs/_sources/usage/installation.rst.txt index fcdbd7d..0458a04 100644 --- a/docs/_sources/usage/installation.rst.txt +++ b/docs/_sources/usage/installation.rst.txt @@ -2,7 +2,7 @@ Installation ============ -This package (For now) will only work on GNU/Linux and requires FFMPEG installed. For now it will be distributed on `GitHub `_ +This package has only been tested on GNU/Linux & Windows and requires FFMPEG installed. For now it will be distributed on `GitHub `_ Install FFmpeg -------------- diff --git a/docs/_sources/usage/manual.rst.txt b/docs/_sources/usage/manual.rst.txt index 109814d..7b94d35 100644 --- a/docs/_sources/usage/manual.rst.txt +++ b/docs/_sources/usage/manual.rst.txt @@ -17,7 +17,7 @@ Synopsis [-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/"] + [-dirs/-files:"/mnt/media/",,"/mnt/media2/"] **for multiple files or filenames use double comma separated values ",,"** @@ -109,8 +109,8 @@ Select the outputs for the video conversions * verbose: Print the FFmpeg output during the video conversions --dir: -===== +-dirs: +====== ["/mnt/media/",,"/mnt/media2/"] The directories to scan as a **double comma** separated values list. @@ -128,11 +128,11 @@ 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 + ./curator.py list -filters:old -print:formated -dirs:/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 -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/" # Convert any video with avi or mpg extensions, print formated text including ffmpeg's output and then delete the originals - ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ + ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/ More examples in :doc:`use_cases` diff --git a/docs/_sources/usage/quickstart.rst.txt b/docs/_sources/usage/quickstart.rst.txt index 68cf34e..74403b4 100644 --- a/docs/_sources/usage/quickstart.rst.txt +++ b/docs/_sources/usage/quickstart.rst.txt @@ -9,7 +9,7 @@ Quickstart [-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/"] + [-dirs/-files:"/mnt/media/",,"/mnt/media2/"] **for multiple files or filenames use double comma separated values ",,"** @@ -27,10 +27,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 + ./curator.py list -filters:old -print:formated -dirs:/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 -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/" # Convert any video with avi or mpg extensions, print formated text including ffmpeg's output and then delete the originals - ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ + ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/ More examples in :doc:`use_cases` \ No newline at end of file diff --git a/docs/_sources/usage/use_cases.rst.txt b/docs/_sources/usage/use_cases.rst.txt index 395d39e..657e164 100644 --- a/docs/_sources/usage/use_cases.rst.txt +++ b/docs/_sources/usage/use_cases.rst.txt @@ -21,13 +21,13 @@ List all videos with old codec in formated format .. code-block:: bash - ./curator.py list -filters:old -dir:/mnt/media/ + ./curator.py list -filters:old -dirs:/mnt/media/ List all videos with substandard definitions with a formated output .. code-block:: bash - ./curator.py list -filters:subsd -print:formated -dir:/mnt/media/ + ./curator.py list -filters:subsd -print:formated -dirs:/mnt/media/ .. _purge: @@ -41,19 +41,19 @@ List and delete all videos using the `Windows Media Video `_ .. code-block:: bash - ./curator.py list -del -in:avi -dir:/mnt/media/ + ./curator.py list -del -in:avi -dirs:/mnt/media/ List and delete any videos with encoding errors .. code-block:: bash - ./curator.py list -del -filters:fferror -dir:/mnt/media/ + ./curator.py list -del -filters:fferror -dirs:/mnt/media/ @@ -66,19 +66,19 @@ List all videos with encoding errors .. code-block:: bash - ./curator.py list -filters:fferror -dir:/mnt/media/ + ./curator.py list -filters:fferror -dirs:/mnt/media/ List and delete any videos with encoding errors .. code-block:: bash - ./curator.py list -del -filters:fferror -dir:/mnt/media/ + ./curator.py list -del -filters:fferror -dirs:/mnt/media/ Convert all videos with encoding errors to `High Efficiency Video Coding `_ and the delete the originals .. code-block:: bash - ./curator.py convert -del -filters:fferror -dir:"/mnt/media/Movies/" + ./curator.py convert -del -filters:fferror -dirs:"/mnt/media/Movies/" .. _convert: @@ -90,16 +90,16 @@ Convert all videos with old codecs to `High Efficiency Video Coding - + @@ -36,7 +36,7 @@

Installation

-

This package (For now) will only work on GNU/Linux and requires FFMPEG installed. For now it will be distributed on GitHub

+

This package has only been tested on GNU/Linux & Windows and requires FFMPEG installed. For now it will be distributed on GitHub

Install FFmpeg

Download FFmpeg

@@ -75,12 +75,14 @@

Navigation

Contents:

@@ -89,7 +91,7 @@

Related Topics

diff --git a/docs/usage/manual.html b/docs/usage/manual.html index 47d54e7..221a118 100644 --- a/docs/usage/manual.html +++ b/docs/usage/manual.html @@ -47,7 +47,7 @@ [-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/"] + [-dirs/-files:"/mnt/media/",,"/mnt/media2/"]

for multiple files or filenames use double comma separated values “,,”

@@ -131,8 +131,8 @@
  • verbose: Print the FFmpeg output during the video conversions

  • -
    -

    -dir:

    +
    +

    -dirs:

    [“/mnt/media/”,,”/mnt/media2/”]

    The directories to scan as a double comma separated values list.

    @@ -145,11 +145,11 @@

    Examples

    # List all videos with old codec in formated format
    -./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
    +./curator.py list -filters:old -print:formated -dirs:/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 -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/"
     # Convert any video with avi or mpg extensions, print formated text including ffmpeg's output and then delete the originals
    -./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
    +./curator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
     

    More examples in Use cases

    diff --git a/docs/usage/quickstart.html b/docs/usage/quickstart.html index bdaeccc..64a1a85 100644 --- a/docs/usage/quickstart.html +++ b/docs/usage/quickstart.html @@ -41,7 +41,7 @@ [-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/"] + [-dirs/-files:"/mnt/media/",,"/mnt/media2/"]

    for multiple files or filenames use double comma separated values “,,”

    @@ -54,11 +54,11 @@

    Examples:

    # List all videos with old codec in formated format
    -./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
    +./curator.py list -filters:old -print:formated -dirs:/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 -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/"
     # Convert any video with avi or mpg extensions, print formated text including ffmpeg's output and then delete the originals
    -./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
    +./curator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
     

    More examples in Use cases

    diff --git a/docs/usage/use_cases.html b/docs/usage/use_cases.html index cab1e64..7206346 100644 --- a/docs/usage/use_cases.html +++ b/docs/usage/use_cases.html @@ -54,11 +54,11 @@