aboutsummaryrefslogtreecommitdiff
path: root/QUICKSTART.md
diff options
context:
space:
mode:
authorAqua-sama <aqua@iserlohn-fortress.net>2018-04-02 11:51:36 +0200
committerAqua-sama <aqua@iserlohn-fortress.net>2018-04-02 11:51:36 +0200
commit33360c1f75012bdb22104fd849053055d2147451 (patch)
treeb4232780dd8542b82b233fad981d0aa6e124d279 /QUICKSTART.md
parentPage menus refactoring (diff)
downloadsmolbote-33360c1f75012bdb22104fd849053055d2147451.tar.xz
Updated documentation
Diffstat (limited to 'QUICKSTART.md')
-rw-r--r--QUICKSTART.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/QUICKSTART.md b/QUICKSTART.md
new file mode 100644
index 0000000..8d8d80b
--- /dev/null
+++ b/QUICKSTART.md
@@ -0,0 +1,37 @@
+## Configuration files
+Configuration is saved in:
+
+- on Linux, _~/.config/smolbote/_
+
+## Keyboard shortcuts
+
+### Navigation
+- Ctrl + Left - go back
+- Ctrl + Right - go forward
+
+### Tabs
+- Ctrl + T - new tab
+- Ctrl + O - previous tab
+- Ctrl + P - next tab
+- Ctrl + X - close tab
+
+## Command line
+
+~~~ sh
+Usage: poi [options] URL
+
+Options:
+- h, help Displays this help.
+- v, version Displays version information.
+- build Show build information.
+- c, config Set configuration file. ~/.config/smolbote/smolbote.cfg
+- p, profile Use this profile.
+- socket Local server socket /tmp/smolbote.socket
+- in-new-window Open URL in new window
+
+You can also overwrite configuration options using the syntax:
+--browser.setting.path=value
+
+Arguments:
+- URL URL(s) to open
+~~~