From 4159cc4e8cd121cd1e7f7f561d00b572635fd2d5 Mon Sep 17 00:00:00 2001 From: Daniel Carl Jones Date: Wed, 18 Oct 2023 09:48:02 +0100 Subject: [PATCH] Improve clarity of LOGGING.md for `--log-directory` argument (#558) * Improve clarity of LOGGING.md for `--log-directory` argument Signed-off-by: Daniel Carl Jones * Add extra mention of `mount-s3` for arguments after we mention `journalctl` Signed-off-by: Daniel Carl Jones --------- Signed-off-by: Daniel Carl Jones --- doc/LOGGING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/LOGGING.md b/doc/LOGGING.md index 254c02c5f..aece11c76 100644 --- a/doc/LOGGING.md +++ b/doc/LOGGING.md @@ -6,11 +6,14 @@ By default, Mountpoint for Amazon S3 emits high-severity log information to [sys On other systems, syslog entries are likely written to a file such as `/var/log/syslog`. -When running in foreground mode (the `-f, --foreground` command-line argument), Mountpoint will emit logs to stdout in addition to syslog or any configured log directory (see below). +When running `mount-s3` in foreground mode (the `-f, --foreground` command-line argument), Mountpoint will emit logs to stdout in addition to syslog or any configured log directory (see below). ## Logging to a file -You can direct logs to a file instead of syslog by providing a destination directory using the `-l, --log-directory` command-line argument. +You can direct logs to a file instead of syslog by providing a destination directory using the `-l, --log-directory` command-line argument with `mount-s3`. + + mount-s3 --log-directory + The directory will be created if it doesn't exist. A new log file will be created for each execution of `mount-s3`. Both the directory and log files are created with read/write access for the process owner and read access for the process owner's group.