From 12066411db802e942bd990cb3c461280ed4adb51 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 29 Mar 2019 20:19:40 +0100 Subject: [PATCH] Update docs with logfile methods --- README.md | 8 +++++--- docs/bot-usage.md | 7 ++++--- docs/configuration.md | 1 + 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ade62ce94..8f7578561 100644 --- a/README.md +++ b/README.md @@ -68,9 +68,9 @@ For any other type of installation please refer to [Installation doc](https://ww ### Bot commands ``` -usage: freqtrade [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME] - [--strategy-path PATH] [--dynamic-whitelist [INT]] - [--db-url PATH] +usage: freqtrade [-h] [-v] [--logfile FILE] [--version] [-c PATH] [-d PATH] + [-s NAME] [--strategy-path PATH] [--dynamic-whitelist [INT]] + [--db-url PATH] [--sd-notify] {backtesting,edge,hyperopt} ... Free, open source crypto trading bot @@ -84,6 +84,7 @@ positional arguments: optional arguments: -h, --help show this help message and exit -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). + --logfile FILE Log to the file specified --version show program's version number and exit -c PATH, --config PATH Specify configuration file (default: None). Multiple @@ -100,6 +101,7 @@ optional arguments: --db-url PATH Override trades database URL, this is useful if dry_run is enabled or in custom deployments (default: None). + --sd-notify Notify systemd service manager. ``` ### Telegram RPC commands diff --git a/docs/bot-usage.md b/docs/bot-usage.md index 35e4a776d..5ec390d5c 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -6,9 +6,9 @@ This page explains the different parameters of the bot and how to run it. ## Bot commands ``` -usage: freqtrade [-h] [-v] [--version] [-c PATH] [-d PATH] [-s NAME] - [--strategy-path PATH] [--dynamic-whitelist [INT]] - [--db-url PATH] +usage: freqtrade [-h] [-v] [--logfile FILE] [--version] [-c PATH] [-d PATH] + [-s NAME] [--strategy-path PATH] [--dynamic-whitelist [INT]] + [--db-url PATH] [--sd-notify] {backtesting,edge,hyperopt} ... Free, open source crypto trading bot @@ -22,6 +22,7 @@ positional arguments: optional arguments: -h, --help show this help message and exit -v, --verbose Verbose mode (-vv for more, -vvv to get all messages). + --logfile FILE Log to the file specified --version show program's version number and exit -c PATH, --config PATH Specify configuration file (default: None). Multiple diff --git a/docs/configuration.md b/docs/configuration.md index 11b941220..75843ef4a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -70,6 +70,7 @@ Mandatory Parameters are marked as **Required**. | `strategy` | DefaultStrategy | Defines Strategy class to use. | `strategy_path` | null | Adds an additional strategy lookup path (must be a folder). | `internals.process_throttle_secs` | 5 | **Required.** Set the process throttle. Value in second. +| `logfile` | | Specify Logfile. Uses a rolling strategy of 10 files, with 1Mb per file. | `internals.sd_notify` | false | Enables use of the sd_notify protocol to tell systemd service manager about changes in the bot state and issue keep-alive pings. See [here](installation.md#7-optional-configure-freqtrade-as-a-systemd-service) for more details. ### Parameters in the strategy