From f56dafe7d946eb8731c7ba7043310e88459b5a7a Mon Sep 17 00:00:00 2001 From: Ovv Date: Mon, 26 Feb 2018 18:52:46 +0100 Subject: [PATCH] Help & documentation --- docs/utilities.rst | 7 +++++++ .../management/commands/document_consumer.py | 19 +++++++++++++++---- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/utilities.rst b/docs/utilities.rst index 2de6e2a01..265e2e78d 100644 --- a/docs/utilities.rst +++ b/docs/utilities.rst @@ -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: diff --git a/src/documents/management/commands/document_consumer.py b/src/documents/management/commands/document_consumer.py index 8efdbe54e..dbd7e3264 100644 --- a/src/documents/management/commands/document_consumer.py +++ b/src/documents/management/commands/document_consumer.py @@ -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):