Skip to content

Commit 440576a

Browse files
committed
Update the manual
1 parent afd138c commit 440576a

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

README.md

+22-19
Original file line numberDiff line numberDiff line change
@@ -48,28 +48,31 @@ Once you have your credentials, you are ready to poll streams! You can easily ac
4848

4949
```bash
5050
fink_consumer -h
51-
usage: fink_consumer [-h] [--display] [-limit LIMIT] [--available_topics]
52-
[--save] [-outdir OUTDIR] [-schema SCHEMA]
53-
[--dump_schema]
51+
usage: fink_consumer [-h] [--display] [--display_statistics] [-limit LIMIT]
52+
[--available_topics] [--save] [-outdir OUTDIR]
53+
[-schema SCHEMA] [--dump_schema] [-start_at START_AT]
5454

55-
Kafka consumer to listen and archive Fink streams from the Livestream
56-
service
55+
Kafka consumer to listen and archive Fink streams from the Livestream service
5756

5857
optional arguments:
59-
-h, --help show this help message and exit
60-
--display If specified, print on screen information about
61-
incoming alert.
62-
-limit LIMIT If specified, download only `limit` alerts. Default is
63-
None.
64-
--available_topics If specified, print on screen information about
65-
available topics.
66-
--save If specified, save alert data on disk (Avro). See also
67-
-outdir.
68-
-outdir OUTDIR Folder to store incoming alerts if --save is set. It
69-
must exist.
70-
-schema SCHEMA Avro schema to decode the incoming alerts. Default is
71-
None (version taken from each alert)
72-
--dump_schema If specified, save the schema on disk (json file)
58+
-h, --help show this help message and exit
59+
--display If specified, print on screen information about
60+
incoming alert.
61+
--display_statistics If specified, print on screen information about queues,
62+
and exit.
63+
-limit LIMIT If specified, download only `limit` alerts. Default is
64+
None.
65+
--available_topics If specified, print on screen information about
66+
available topics.
67+
--save If specified, save alert data on disk (Avro). See also
68+
-outdir.
69+
-outdir OUTDIR Folder to store incoming alerts if --save is set. It
70+
must exist.
71+
-schema SCHEMA Avro schema to decode the incoming alerts. Default is
72+
None (version taken from each alert)
73+
--dump_schema If specified, save the schema on disk (json file)
74+
-start_at START_AT If specified, reset offsets to 0 (`earliest`) or empty
75+
queue (`latest`).
7376
```
7477
7578
You can also look at an alert on the disk:

0 commit comments

Comments
 (0)