From 308a6ea3d3311aba87aaec99f1ab2293d13a4a03 Mon Sep 17 00:00:00 2001 From: thebaptiste Date: Fri, 9 Feb 2024 16:13:35 +0000 Subject: [PATCH] build: complete README --- .metwork-framework/README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/.metwork-framework/README.md b/.metwork-framework/README.md index 96cc6d5..677f2dd 100644 --- a/.metwork-framework/README.md +++ b/.metwork-framework/README.md @@ -100,17 +100,24 @@ Help Options: Application Options: -s, --rotation-size maximum size (in bytes) for a log file before rotation (0 => no maximum, default: content of environment variable LOGPROXY_ROTATION_SIZE or 104857600 (100MB)) -t, --rotation-time maximum lifetime (in seconds) for a log file before rotation (0 => no maximum, default: content of environment variable LOGPROXY_ROTATION_TIME or 86400 (24H)) - -S, --rotation-suffix strftime based suffix to append to rotated log files (default: content of environment variable LOGPROXY_ROTATION_SUFFIX or .%Y%m%d%H%M%S) + -S, --rotation-suffix strftime based suffix to append to rotated log files (default: content of environment variable LOGPROXY_ROTATION_SUFFIX or .%%Y%%m%%d%%H%%M%%S) + -d, --log-directory directory to store log files (default: content of environment variable LOGPROXY_LOG_DIRECTORY or current directory), directory is created if missing -n, --rotated-files maximum number of rotated files to keep including main one (0 => no cleaning, default: content of environment variable LOGPROXY_ROTATED_FILES or 5) + -T, --timestamps strftime prefix to prepend to every output line (default: content of environment variable LOGPROXY_TIMESTAMPS or none) + -c, --chmod if set, chmod the logfile to this value, '0700' for example (default: content of environment variable LOGPROXY_CHMOD or NULL) + -o, --chown if set, try (if you don't have sufficient privileges, it will fail silently) to change the owner of the logfile to the given user value + -g, --chgrp if set, try (if you don't have sufficient privileges, it will fail silently) to change the group of the logfile to the given group value -m, --use-locks use locks to append to main log file (useful if several process writes to the same file) -f, --fifo if set, read lines on this fifo instead of stdin -r, --rm-fifo-at-exit if set, drop fifo at then end of the program (you have to use --fifo option of course) -Optional environment variables to override defaults : +Optional environment variables to override defaults: LOGPROXY_ROTATION_SIZE LOGPROXY_ROTATION_TIME LOGPROXY_ROTATION_SUFFIX + LOGPROXY_LOG_DIRECTORY LOGPROXY_ROTATED_FILES + LOGPROXY_TIMESTAMPS Example for rotation-size option : - If log_proxy is run with the option --rotation-size on command line, rotation-size will take the provided value @@ -141,7 +148,8 @@ Application Options: -S, --rotation-suffix strftime based suffix to append to rotated log files (default: content of environment variable LOGPROXY_ROTATION_SUFFIX or .%%Y%%m%%d%%H%%M%%S) -d, --log-directory directory to store log files (default: content of environment variable LOGPROXY_LOG_DIRECTORY or current directory), directory is created if missing -n, --rotated-files maximum number of rotated files to keep including main one (0 => no cleaning, default: content of environment variable LOGPROXY_ROTATED_FILES or 5) - -c, --chmod if set, chmod the logfile to this octal value (0700 for example) + -T, --timestamps strftime prefix to prepend to every output line (default: content of environment variable LOGPROXY_TIMESTAMPS or none) + -c, --chmod if set, chmod the logfile to this value, '0700' for example (default: content of environment variable LOGPROXY_CHMOD or NULL) -o, --chown if set, try (if you don't have sufficient privileges, it will fail silently) to change the owner of the logfile to the given user value -g, --chgrp if set, try (if you don't have sufficient privileges, it will fail silently) to change the group of the logfile to the given group value -m, --use-locks use locks to append to main log file (useful if several process writes to the same file)