Help & documentation

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:
 

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):