Help & documentation

This commit is contained in:
Ovv 2018-02-26 18:52:46 +01:00 committed by Daniel Quinn
parent 7a1754fffd
commit f56dafe7d9
2 changed files with 22 additions and 4 deletions

View File

@ -80,6 +80,13 @@ you'll need to have it start in the background -- something you'll need to
figure out for your own system. To get you started though, there are Systemd
service files in the ``scripts`` directory.
Some command line argument are available to customize the behavior of the
consumer. By default it will use ``/etc/paperless.conf`` values. Display the
help with:
.. code-block:: shell-session
$ /path/to/paperless/src/manage.py document_consumer --help
.. _utilities-exporter:

View File

@ -33,15 +33,26 @@ class Command(BaseCommand):
parser.add_argument(
"directory",
default=settings.CONSUMPTION_DIR,
nargs="?"
nargs="?",
help="The consumption directory."
)
parser.add_argument(
"--loop-time",
default=settings.CONSUMER_LOOP_TIME,
type=int
type=int,
help="Wait time between each loop (in seconds)."
)
parser.add_argument(
"--mail-delta",
default=10,
type=int,
help="Wait time between each mail fetch (in minutes)."
)
parser.add_argument(
"--oneshot",
action="store_true",
help="Run only once."
)
parser.add_argument("--mail-delta", default=10, type=int)
parser.add_argument("--oneshot", action="store_true")
def handle(self, *args, **options):