From 38ccac88ca0d6502e7dc730e3e6e41bc461cf724 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Sat, 26 Nov 2016 01:36:39 +0300 Subject: [PATCH] Add a simple documentation stub for the EXE Config File --- README.md | 4 ++-- doc/exeConfigFile.md | 10 ++++++++++ doc/xmlConfigFile.md | 4 ++-- 3 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 doc/exeConfigFile.md diff --git a/README.md b/README.md index 6e5b8e3..ae9c455 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This source of releases is not an **official one**. ### Usage -WinSW is being managed by configuration files: [Main XML Configuration file](doc/xmlConfigFile.md) and [EXE .config file](TODO). +WinSW is being managed by configuration files: [Main XML Configuration file](doc/xmlConfigFile.md) and [EXE Config file](doc/exeConfigFile.md). Your renamed `winsw.exe` binary also accepts the following commands: @@ -35,7 +35,7 @@ Your renamed `winsw.exe` binary also accepts the following commands: * [Release notes](CHANGELOG.md) * Configuration: * [Main XML Configuration file](doc/xmlConfigFile.md) - * [Configuration File](doc/xmlConfigFile.md) + * [EXE Configuration File](doc/exeConfigFile.md) * [Logging and Error Reporting](doc/loggingAndErrorReporting.md) * Use-cases: * [Self-restarting services](doc/selfRestartingService.md) diff --git a/doc/exeConfigFile.md b/doc/exeConfigFile.md new file mode 100644 index 0000000..fdd7c92 --- /dev/null +++ b/doc/exeConfigFile.md @@ -0,0 +1,10 @@ +WinSW EXE Configuration File +==== + +In addition to the [XML Configuration File](xmlConfigFile.md), WinSW uses a standard .NET `winsw.exe.config` file, which allows setting up some custom settings. + +Use-cases: +* Declaring compatibility with newer .NET versions (see the [Installation Guide](installation.md)) +* Managing custom behavior for the offline mode (see the [Installation Guide](installation.md)) +* Managing Logging levels of log4j +* etc. \ No newline at end of file diff --git a/doc/xmlConfigFile.md b/doc/xmlConfigFile.md index 43033c9..c1943e2 100644 --- a/doc/xmlConfigFile.md +++ b/doc/xmlConfigFile.md @@ -1,5 +1,5 @@ -Configuration File Syntax -------------------------- +WinSW XML Configuration File +==== This page describes the configuration file, which controls the behavior of the Jenkins service.