diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 10 | ||||
| -rw-r--r-- | docs/tml-config.md | 7 |
2 files changed, 15 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md index 7e01ebd..a3b3842 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ ## Compiling and Running -tml can be installed 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 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` @@ -20,4 +20,10 @@ By default, tml searches in the following order for a config file: 2. `$HOME/.tml/config` 3. `config` (in the current directory) -A different config file location can also be specified with the `-c` flag. For Documentation of the config file, see [tml-config](tml-config.md) +A different config 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) diff --git a/docs/tml-config.md b/docs/tml-config.md index 3b843e1..e0c782b 100644 --- a/docs/tml-config.md +++ b/docs/tml-config.md @@ -15,6 +15,7 @@ - [addNameF](#addNameF) - [addR](#addR) - [hide](#hide) + - [hideFile](#hideFile) - [Settings](#Settings) - [autoAlias](#autoAlias) - [compMode](#compMode) @@ -84,6 +85,12 @@ tml will hide empty groups, so you will need to know how to add entries to a gro `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*. +### hideFile + +- **hideFile** *path* *group* + +`hideFile` has the exact same functionality as `hide`, but takes the absolute path of the entry to hide as the first argument, instead of the name. + ## Settings If any of the following settings are specified, they should be at the top of the config file. |