Skip to content

Commit 96e64c5

Browse files
committed
Explicitly state that -o support both file and format as argument
1 parent 0601571 commit 96e64c5

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -217,11 +217,11 @@ build GoAccess from source.
217217

218218
A Docker image has been updated, capable of directing output from an access log. If you only want to output a report, you can pipe a log from the external environment to a Docker-based process:
219219

220-
cat access.log | docker run --rm -i -e LANG=$LANG allinurl/goaccess -a -o html --log-format COMBINED - > report.html
220+
cat access.log | docker run --rm -i -e LANG=$LANG allinurl/goaccess -a -o report.html --log-format COMBINED -
221221

222222
OR real-time
223223

224-
tail -F access.log | docker run -p 7890:7890 --rm -i -e LANG=$LANG allinurl/goaccess -a -o html --log-format COMBINED --real-time-html - > report.html
224+
tail -F access.log | docker run -p 7890:7890 --rm -i -e LANG=$LANG allinurl/goaccess -a -o report.html --log-format COMBINED --real-time-html -
225225

226226
You can read more about using the docker image in [DOCKER.md](https://github.com/allinurl/goaccess/blob/master/DOCKER.md).
227227

@@ -265,13 +265,13 @@ To generate an HTML report:
265265

266266
# goaccess access.log -a > report.html
267267

268-
To generate a JSON report:
268+
To generate a JSON report file:
269269

270-
# goaccess access.log -a -d -o json > report.json
270+
# goaccess access.log -a -d -o report.json
271271

272-
To generate a CSV file:
272+
To generate a CSV report to stdout:
273273

274-
# goaccess access.log --no-csv-summary -o csv > report.csv
274+
# goaccess access.log --no-csv-summary -o csv
275275

276276
GoAccess also allows great flexibility for real-time filtering and parsing. For
277277
instance, to quickly diagnose issues by monitoring logs since goaccess was

src/options.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,8 @@ cmd_help (void)
263263
" ranges. e.g., 192.168.0.1-192.168.0.10\n"
264264
" -H --http-protocol=<yes|no> - Set/unset HTTP request protocol if found.\n"
265265
" -M --http-method=<yes|no> - Set/unset HTTP request method if found.\n"
266-
" -o --output=file.html|json|csv - Output either an HTML, JSON or a CSV file.\n"
266+
" -o --output=<format|filename> - Output to stdout or the specified file.\n"
267+
" e.g., -o csv, -o out.json, --output=report.html\n"
267268
" -q --no-query-string - Strip request's query string. This can\n"
268269
" decrease memory consumption.\n"
269270
" -r --no-term-resolver - Disable IP resolver on terminal output.\n"

0 commit comments

Comments
 (0)