diff --git a/README.md b/README.md index d3b440a..7957a52 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,7 @@ Detailed help documentation is available for several topics. * [Selective scanning](/docs/help/selective-scanning.md) ### Interfaces +* [Application folder](/docs/help/application-folder.md) * [Backup structure](/docs/help/backup-structure.md) * [Command line](/docs/help/command-line.md) * [Configuration file](/docs/help/configuration-file.md) diff --git a/docs/help/application-folder.md b/docs/help/application-folder.md new file mode 100644 index 0000000..9e05b7d --- /dev/null +++ b/docs/help/application-folder.md @@ -0,0 +1,16 @@ +# Application folder +Ludusavi stores its configuration/logs/etc in the following locations: + +* Windows: `%APPDATA%/ludusavi` +* Linux: `$XDG_CONFIG_HOME/ludusavi` or `~/.config/ludusavi` + * Flatpak: `~/.var/app/com.github.mtkennerly.ludusavi/config/ludusavi` +* Mac: `~/Library/Application Support/ludusavi` + +Alternatively, if you'd like Ludusavi to store its configuration in the same +place as the executable, then simply create a file called `ludusavi.portable` +in the directory that contains the executable file. You might want to do that +if you're going to run Ludusavi from a flash drive on multiple computers. + +Ludusavi also stores `manifest.yaml` (info on what to back up) here. +You should not modify that file, because Ludusavi will overwrite your changes +whenever it downloads a new copy. diff --git a/docs/help/configuration-file.md b/docs/help/configuration-file.md index 2168cdc..115e809 100644 --- a/docs/help/configuration-file.md +++ b/docs/help/configuration-file.md @@ -1,24 +1,11 @@ # Configuration -Ludusavi stores its configuration in the following locations: - -* Windows: `%APPDATA%/ludusavi` -* Linux: `$XDG_CONFIG_HOME/ludusavi` or `~/.config/ludusavi` - * Flatpak: `~/.var/app/com.github.mtkennerly.ludusavi/config/ludusavi` -* Mac: `~/Library/Application Support/ludusavi` - -Alternatively, if you'd like Ludusavi to store its configuration in the same -place as the executable, then simply create a file called `ludusavi.portable` -in the directory that contains the executable file. You might want to do that -if you're going to run Ludusavi from a flash drive on multiple computers. +Ludusavi stores its configuration in the [application folder](/docs/help/application-folder.md), +in a file named `config.yaml`. If you're using the GUI, then it will automatically update the config file as needed, so you don't need to worry about its content. However, if you're using the CLI exclusively, then you'll need to edit `config.yaml` yourself. -Ludusavi also stores `manifest.yaml` (info on what to back up) here. -You should not modify that file, because Ludusavi will overwrite your changes -whenever it downloads a new copy. - ## Schema [docs/schema/config.yaml](/docs/schema/config.yaml) diff --git a/docs/help/logging.md b/docs/help/logging.md index 3529f8d..e7017ac 100644 --- a/docs/help/logging.md +++ b/docs/help/logging.md @@ -1,5 +1,8 @@ # Logging -Log files are stored in the config folder (see above). +Log files are stored in the [application folder](/docs/help/application-folder.md). +The latest log file is named `ludusavi_rCURRENT.log`, +and any other log files will be named with a timestamp (e.g., `ludusavi_r2000-01-02_03-04-05.log`). + By default, only warnings and errors are logged, but you can customize this by setting the `RUST_LOG` environment variable (e.g., `RUST_LOG=ludusavi=debug`).