summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJesse Duffield <jessedduffield@gmail.com>2018-09-03 19:53:16 +1000
committerGitHub <noreply@github.com>2018-09-03 19:53:16 +1000
commit6fc4cb1b96b217a6031a07f590b210d7fc79c00a (patch)
tree5b082fcbe7f64662f7bd46f9b9f085b48459224a /docs
parent39f065207eb8cc0efe4abe511668749a22aafc79 (diff)
parent3c1935fee426c223b3a64dc75e8f7dd7358c7462 (diff)
Merge branch 'master' into rename-commits-in-user-editor
Diffstat (limited to 'docs')
-rw-r--r--docs/Config.md36
1 files changed, 32 insertions, 4 deletions
diff --git a/docs/Config.md b/docs/Config.md
index b2711b603..d428603bc 100644
--- a/docs/Config.md
+++ b/docs/Config.md
@@ -14,16 +14,44 @@
- white
optionsTextColor:
- blue
- git:
- # stuff relating to git
- os:
- # stuff relating to the OS
update:
method: prompt # can be: prompt | background | never
days: 14 # how often an update is checked for
reporting: 'undetermined' # one of: 'on' | 'off' | 'undetermined'
```
+## Platform Defaults:
+
+### Windows:
+
+```
+ os:
+ openCommand: 'cmd /c "start "" {{filename}}"'
+```
+
+### Linux:
+
+```
+ os:
+ openCommand: 'bash -c \"xdg-open {{filename}} &>/dev/null &\"'
+```
+
+### OSX:
+
+```
+ os:
+ openCommand: 'open {{filename}}'
+```
+
+### Recommended Config Values:
+
+for users of VSCode
+
+```
+ os:
+ openCommand: 'code -r {{filename}}'
+```
+
## Color Attributes:
For color attributes you can choose an array of attributes (with max one color attribute)