From 5b279542ba234d8ca129f72e22332b2f98408de6 Mon Sep 17 00:00:00 2001 From: louie Date: Mon, 14 Sep 2020 10:08:44 -0700 Subject: Created man page templates, minor documentation adjustments --- docs/README.md | 14 +++++++------- docs/tml-config.5.gz | Bin 0 -> 2213 bytes docs/tml-config.md | 8 ++++---- docs/tml.1.gz | Bin 0 -> 610 bytes 4 files changed, 11 insertions(+), 11 deletions(-) create mode 100644 docs/tml-config.5.gz create mode 100644 docs/tml.1.gz (limited to 'docs') diff --git a/docs/README.md b/docs/README.md index a3b3842..86ce1fa 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,29 +1,29 @@ ## Introduction -**Terminal Media Launcher** is a command line utility to help streamline launching applications and other media. The goal of tml is to provide a fast, minimal, command line frontend with a Unix-like approach to setup and configuration. The program looks for a config file listing different groups of media and creates an ncurses menu from which to select from. +**Terminal Media Launcher** is a command line utility to help streamline launching applications and other media. The goal of tml is to provide a fast, minimal, command line frontend with a Unix-like approach to setup and configuration. The program looks for a configuration file listing different groups of media and creates an ncurses menu from which to select from. If a configuration file is found, the program will draw two columns: one for groups, and one for entries. At the bottom of the window, a preview of the command execution is displayed. ## Compiling and Running -tml can be compiled on any system with gcc and the ncurses library installed. It has been tested to work on Ubuntu and Windows 10. To compile and run tml: +tml can be compiled on any system with gcc and the ncurses library installed. It has been tested to work on Ubuntu, 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` 3. `./tml` to run the program -Note that tml will not run until you have created a config file. +Note that tml will not run until you have created a configuration file. -## Config File +## Configuration File -By default, tml searches in the following order for a config file: +By default, tml searches in the following order for a configuration file: 1. `$HOME/.config/tml/config` 2. `$HOME/.tml/config` 3. `config` (in the current directory) -A different config file location can also be specified with the `-c` flag: +A different configuration file location can also be specified with the `-c` flag: ``` tml -c /path/to/config ``` -For Documentation of the config file, see [tml-config](tml-config.md) +For Documentation of the configuration file, see [tml-config](tml-config.md) diff --git a/docs/tml-config.5.gz b/docs/tml-config.5.gz new file mode 100644 index 0000000..aec0c18 Binary files /dev/null and b/docs/tml-config.5.gz differ diff --git a/docs/tml-config.md b/docs/tml-config.md index e0c782b..bee5a78 100644 --- a/docs/tml-config.md +++ b/docs/tml-config.md @@ -57,7 +57,7 @@ tml will hide empty groups, so you will need to know how to add entries to a gro ### addF -- **addF** *arg* *group* +- **addF** *new-entry* *group* `addF` will force an entry to be added to a specified group, regardless as to whether it is a valid file or not. Unlike `add`, `addF`'s argument does not need to be a valid file, but `addF` can only specify a single entry and does not support the '\*' operator. If the arg has a space in it, it must be written in quotes. @@ -69,7 +69,7 @@ tml will hide empty groups, so you will need to know how to add entries to a gro ### addNameF -- **addNameF** *name* *arg* *group* +- **addNameF** *name* *new-entry* *group* `addNameF` can be used in place of `addF` if you want the forced argument to have a different name displayed for the entry than is called in the system call to launch the entry. Otherwise, it is effectively the same as `addF` @@ -83,7 +83,7 @@ tml will hide empty groups, so you will need to know how to add entries to a gro - **hide** *entry* *group* -`hide` will remove a specified entry from a specified group. The entry argument should refer to the entry's name, rather than the entry's path. This option may be useful to hide certain files after adding entries with the '\*' operator. *At the moment, hide can only hide a single entry*. +`hide` will remove a specified entry from a specified group. The entry argument should refer to the entry's name, rather than the entry's path. This option may be useful to hide certain entries after adding entries with the '\*' operator. *At the moment, hide can only hide a single entry*. ### hideFile @@ -99,7 +99,7 @@ If any of the following settings are specified, they should be at the top of the - **autoAlias** *on/off* -`autoAlias` will attempt to automatically give entries more human-readable names based on their filename by: +`autoAlias` will attempt to automatically give entries more human-readable names by: 1. Removing any characters inside parenthesis (including parenthesis) 2. Replacing '-' and '\_' with a space character diff --git a/docs/tml.1.gz b/docs/tml.1.gz new file mode 100644 index 0000000..1431efe Binary files /dev/null and b/docs/tml.1.gz differ -- cgit