From fa8e3992ef7060168770ccccabdfe3b2982ea700 Mon Sep 17 00:00:00 2001 From: louie Date: Sun, 20 Dec 2020 15:35:43 -0800 Subject: Updated docs to reflect changes from last commit --- docs/README.md | 11 ++++++++--- docs/tml-config.5.gz | Bin 2150 -> 2235 bytes docs/tml-config.md | 6 +++--- docs/tml.1.gz | Bin 862 -> 914 bytes 4 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index db5da29..e5b8605 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ ## Compiling and Running -tml can be compiled on any system with make, gcc, and the ncurses library (libncurses-dev) installed. It has been tested to work on Ubuntu, and can also be compiled and run on Windows 10, but is designed with Linux in mind. To compile and run tml: +tml can be compiled on any system with make, gcc, and the ncurses library (libncurses-dev) installed. It can be compiled and installed on any Linux distribution, and can also be compiled and run on Windows 10. To compile and run tml: 1. Clone the repository 2. Run `make` in the directory the repository was cloned into. This will create a file called `tml` @@ -14,7 +14,7 @@ Note that tml will not run until you have created a configuration file. ### Installation -tml can be installed by running: +tml can be installed on Linux by running: ``` sudo make install @@ -36,9 +36,14 @@ sudo make uninstall By default, tml searches in the following order for a configuration file: +### Linux + 1. `$HOME/.config/tml/config` 2. `$HOME/.tml/config` -3. `config` (in the current directory) + +### Windows + +1. `%APPDATA%\tml\config` A different configuration file location can also be specified with the `-c` flag: diff --git a/docs/tml-config.5.gz b/docs/tml-config.5.gz index 429dd3d..6ec7aac 100644 Binary files a/docs/tml-config.5.gz and b/docs/tml-config.5.gz differ diff --git a/docs/tml-config.md b/docs/tml-config.md index b02ee21..dd9c834 100644 --- a/docs/tml-config.md +++ b/docs/tml-config.md @@ -1,6 +1,6 @@ ## Introduction -**config** specifies settings for Terminal Media Launcher, including preferences, groups, entries, and file locations. Each line of `config` is read by tml unless the line is empty or the line begins with a '#'. tml will not run if no config file exists, so you will need to know how to write one +**config** specifies settings for Terminal Media Launcher, including preferences, groups, entries, and file locations. Each line of `config` is read by tml unless the line is empty or the line begins with a '#'. tml can automatically generate a configuration file if no such file is found. An automatically generated configuration file will create groups for Music, Pictures, and Videos, and add entries to each group from the respective directory in the user's home directory. It is highly recommended that the user edit the configuration file manually. ## Table of Contents @@ -30,13 +30,13 @@ tml will not work without any groups, so you will need to know how to create a g - **addGroup** *name* -`addGroup` will create a new group with a specified name. By default this group is empty, with zero entries, no launching application specified, and no flags specified. If their is a space in the name, it must be written in quotes (ex. "TV Shows") +`addGroup` will create a new group with a specified name. By default this group is empty, with zero entries, no launching application specified, and no flags specified. If there is a space in the name, it must be written in quotes (ex. "TV Shows") ### setLauncher - **setLauncher** *group* */path/to/launcher* -`setLauncher` will set a group's launching application. If no launching application is specified for a group, tml will treat each entry in that group as an executable file. If their is a space in the path to the launching application, it must be written in quotes (ex. "/usr/bin/my launcher"). *Keep in mind that the path to the launching application should be absolute*. +`setLauncher` will set a group's launching application. If no launching application is specified for a group, tml will treat each entry in that group as an executable file. If there is a space in the path to the launching application, it must be written in quotes (ex. "/usr/bin/my launcher"). *Keep in mind that the path to the launching application should be absolute*. ### setFlags diff --git a/docs/tml.1.gz b/docs/tml.1.gz index 3ec54f3..f93cd14 100644 Binary files a/docs/tml.1.gz and b/docs/tml.1.gz differ -- cgit