Git/cheat
1
0
Fork 0
mirror of https://github.com/cheat/cheat.git synced 2024-11-23 14:31:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Replace erroneous 'conf.yaml' by 'conf.yml'

Browse Source
This commit is contained in:
Stanislas Marquis 2022-09-28 15:41:19 +02:00
parent 5be1982b9b
commit 3d5197c631
No known key found for this signature in database
GPG Key ID: 9FBD8D0561118878
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/cheat.1.md
View File

@ -100,13 +100,13 @@ FILES
Configuration Configuration
------------- -------------
**cheat** is configured via a YAML file that is conventionally named **cheat** is configured via a YAML file that is conventionally named
_conf.yaml_. **cheat** will search for _conf.yaml_ in varying locations, _conf.yml_. **cheat** will search for _conf.yml_ in varying locations,
depending upon your platform: depending upon your platform:
### Linux, OSX, and other Unixes ### ### Linux, OSX, and other Unixes ###
1. **CHEAT_CONFIG_PATH** 1. **CHEAT_CONFIG_PATH**
2. **XDG_CONFIG_HOME**/cheat/conf.yaml 2. **XDG_CONFIG_HOME**/cheat/conf.yml
3. **$HOME**/.config/cheat/conf.yml 3. **$HOME**/.config/cheat/conf.yml
4. **$HOME**/.cheat/conf.yml 4. **$HOME**/.cheat/conf.yml
@ -116,7 +116,7 @@ depending upon your platform:
2. **APPDATA**/cheat/conf.yml 2. **APPDATA**/cheat/conf.yml
3. **PROGRAMDATA**/cheat/conf.yml 3. **PROGRAMDATA**/cheat/conf.yml
**cheat** will search in the order specified above. The first _conf.yaml_ **cheat** will search in the order specified above. The first _conf.yml_
encountered will be respected. encountered will be respected.
If **cheat** cannot locate a config file, it will ask if you'd like to generate If **cheat** cannot locate a config file, it will ask if you'd like to generate
@ -128,7 +128,7 @@ for your platform.
Cheatpaths Cheatpaths
---------- ----------
**cheat** reads its cheatsheets from "cheatpaths", which are the directories in **cheat** reads its cheatsheets from "cheatpaths", which are the directories in
which cheatsheets are stored. Cheatpaths may be configured in _conf.yaml_, and which cheatsheets are stored. Cheatpaths may be configured in _conf.yml_, and
viewed via **cheat -d**. viewed via **cheat -d**.
For detailed instructions on how to configure cheatpaths, please refer to the For detailed instructions on how to configure cheatpaths, please refer to the