diff --git a/README.md b/README.md index 8dda3d7..ba46c11 100644 --- a/README.md +++ b/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/"] diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index d4816e0..8e32bc7 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -21,6 +21,7 @@ The source code can be found on `GitHub `_ 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... diff --git a/docs/_sources/usage/manual.rst.txt b/docs/_sources/usage/manual.rst.txt new file mode 100644 index 0000000..cb3979f --- /dev/null +++ b/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/ diff --git a/docs/genindex.html b/docs/genindex.html index d22fdb9..a73890a 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -63,6 +63,7 @@ diff --git a/docs/index.html b/docs/index.html index d6b6986..675ca54 100644 --- a/docs/index.html +++ b/docs/index.html @@ -51,6 +51,7 @@
  • Quickstart
    • +
  • Manual
  • Use cases
  • Errors