diff --git a/README.md b/README.md index 9699a3e..d159c3f 100644 --- a/README.md +++ b/README.md @@ -62,15 +62,16 @@ Now you got pip up and running! The next move is to install the tool using it Check out the help command ``cerda -h``:: - usage: cerda [-h] [-dbox] [-e EMAIL] [-c COUNT] [-r EVERY] source target + usage: cerda [-h] [-dbox] [-e EMAIL] [-c COUNT] [-r EVERY] [-t CUSTOMTYPES] + source target An NCCA render farm collector. positional arguments: source Remote location path (relative to home) where the frames get generated. - target Destination location path where you would like the - frames to get sent to. + target Custom file extensions to mark for transfering. I.e. + -t tiff,exr,obj optional arguments: -h, --help show this help message and exit @@ -84,6 +85,9 @@ Check out the help command ``cerda -h``:: specified with -m flag. -r EVERY, --every EVERY How often to check for frames dropped (in seconds) + -t CUSTOMTYPES, --customTypes CUSTOMTYPES + Custom file extensions to mark for transfering. I.e. + -t tiff,exr,obj **WARNING:** Please make sure the **paths** you pass in are relative to your home folder. @@ -127,3 +131,17 @@ When it is finished you will receive an email from **cerdancca@gmail.com**. Hopefully it won't get blocked as I am using Google's own SMTP servers. If you find any problem or bug please report it using the Issues page or drop me a line at blanquer.ramon@gmail.com + +#### Example 4 +My renderfarm is rendering out Alembic **.abc** files at ``/home/i7243466/project1/render`` +on the **tete** server. I want the files to get transfered to my local drive at +location ``/home/i7243466/hello/alembics``:: + + $ cerda project1/render hello/alembics --customTypes abc + +Or you could also use the short flags:: + + $ cerda project1/render hello/alembics --t abc + +You can specify more than custom type to transfer like ``--customTypes png,jpg,abc,tiff`` +No spaces, separated by commas. \ No newline at end of file diff --git a/README.rst b/README.rst index 701d3ba..2d90af8 100644 --- a/README.rst +++ b/README.rst @@ -68,15 +68,16 @@ Usage Check out the help command ``cerda -h``:: - usage: cerda [-h] [-dbox] [-e EMAIL] [-c COUNT] [-r EVERY] source target + usage: cerda [-h] [-dbox] [-e EMAIL] [-c COUNT] [-r EVERY] [-t CUSTOMTYPES] + source target An NCCA render farm collector. positional arguments: source Remote location path (relative to home) where the frames get generated. - target Destination location path where you would like the - frames to get sent to. + target Custom file extensions to mark for transfering. I.e. + -t tiff,exr,obj optional arguments: -h, --help show this help message and exit @@ -90,6 +91,9 @@ Check out the help command ``cerda -h``:: specified with -m flag. -r EVERY, --every EVERY How often to check for frames dropped (in seconds) + -t CUSTOMTYPES, --customTypes CUSTOMTYPES + Custom file extensions to mark for transfering. I.e. + -t tiff,exr,obj **WARNING:** Please make sure the **paths** you pass in are relative to your home folder. @@ -140,3 +144,20 @@ When it is finished you will receive an email from **cerdancca@gmail.com**. Hopefully it won't get blocked as I am using Google's own SMTP servers. If you find any problem or bug please report it using the Issues page or drop me a line at blanquer.ramon@gmail.com + +Example 4 +--------- + +My renderfarm is rendering out Alembic **.abc** files at ``/home/i7243466/project1/render`` +on the **tete** server. I want the files to get transfered to my local drive at +location ``/home/i7243466/hello/alembics``:: + + $ cerda project1/render hello/alembics --customTypes abc + +Or you could also use the short flags:: + + $ cerda project1/render hello/alembics --t abc + +.. note:: + You can specify more than custom type to transfer like ``--customTypes png,jpg,abc,tiff`` + No spaces, separated by commas. \ No newline at end of file