diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 2 | ||||
| -rw-r--r-- | docs/tml-config.md | 8 |
2 files changed, 9 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md index 14ce9d6..7e01ebd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ ## Introduction -**Terminal Media Launcher** is a command line utility to help streamline launching applications and other media. 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 config file listing different groups of media and creates an ncurses menu from which to select from. ## Compiling and Running diff --git a/docs/tml-config.md b/docs/tml-config.md index 451d47f..f4a1faa 100644 --- a/docs/tml-config.md +++ b/docs/tml-config.md @@ -14,6 +14,7 @@ - [addName](#addName) - [addNameF](#addNameF) - [addR](#addR) + - [hide](#hide) - [Settings](#Settings) - [autoAlias](#autoAlias) - [compMode](#compMode) @@ -76,6 +77,12 @@ tml will hide empty groups, so you will need to know how to add entries to a gro `addR` will recursively add entries to a group. `addR` functions like `add`, but will also search sub-directories for matches. +### hide + +- **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*. + ## Settings If any of the following settings are specified, they should be at the top of the config file. @@ -89,6 +96,7 @@ If any of the following settings are specified, they should be at the top of the 1. Removing any characters inside parenthesis (including parenthesis) 2. Replacing '-' and '\_' with a space character 3. Replacing cases of multiple spaces in a row with only one space +4. Removing file extensions (if the file has an extension) `autoAlias` is turned off by default. |