aboutsummaryrefslogtreecommitdiff
path: root/linux
diff options
context:
space:
mode:
Diffstat (limited to 'linux')
-rw-r--r--linux/man/smolbote.7188
-rw-r--r--linux/man/smolbote.7.html131
-rw-r--r--linux/man/smolbote.7.ronn83
3 files changed, 356 insertions, 46 deletions
diff --git a/linux/man/smolbote.7 b/linux/man/smolbote.7
index 9bf2458..e68248d 100644
--- a/linux/man/smolbote.7
+++ b/linux/man/smolbote.7
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "SMOLBOTE" "7" "February 2018" "" ""
+.TH "SMOLBOTE" "7" "March 2018" "" ""
.
.SH "NAME"
\fBsmolbote\fR \- yet another no\-frills browser
@@ -9,33 +9,177 @@
.SH "SYNOPSIS"
\fBpoi\fR [\fIoptions\fR\.\.\.] URL
.
+.SH "DESCRIPTION"
+smolbote is a keep\-it\-simple free software web browser\.
+.
.SH "OPTIONS"
.
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-Displays this help\.
+.SS "General"
+.
+.IP "\(bu" 4
+\fB\-h\fR, \fB\-\-help\fR: Displays this help\.
+.
+.IP "\(bu" 4
+\fB\-v\fR, \fB\-\-version\fR: Displays version information\.
+.
+.IP "\(bu" 4
+\fB\-\-build\fR: Displays build information\.
+.
+.IP "" 0
+.
+.SS "Configuration"
+.
+.IP "\(bu" 4
+\fB\-c\fR, \fB\-\-config\fR: Set configuration file\.
+.
+.IP "\(bu" 4
+\fB\-\-socket\fR: Local server socket
+.
+.IP "" 0
+.
+.SS "Open URL"
+.
+.IP "\(bu" 4
+\fB\-p\fR, \fB\-\-profile\fR: Use this profile\.
+.
+.IP "\(bu" 4
+\fB\-\-in\-new\-window\fR: Open URL in new window\.
+.
+.IP "" 0
+.
+.SH "CONFIGURATION"
+The Configuration is loaded from \fI~/\.config/smolbote/smolbote\.cfg\fR, and can be edited with the \fBpoi\-config\fR tool\.
+.
+.P
+Settings are only loaded on launch, so re\-run the browser to apply changes\.
+.
+.IP "\(bu" 4
+browser\.profile: Profile to be used by default, "" is off\-the\-record
+.
+.IP "" 0
+.
+.SS "Default window size"
+.
+.IP "\(bu" 4
+browser\.window\.height: 720
+.
+.IP "\(bu" 4
+browser\.window\.width: 1280
+.
+.IP "\(bu" 4
+browser\.window\.maximized: true
+.
+.IP "\(bu" 4
+browser\.window\.title: title — smolbote [profile]
+.
+.IP "" 0
+.
+.SS "Window UI"
+.
+.IP "\(bu" 4
+browser\.ui\.navtoolbarMovable: false
+.
+.IP "\(bu" 4
+browser\.ui\.tabtoolbarMovable: false
+.
+.IP "" 0
+.
+.SS "Shortcuts"
+.
+.IP "\(bu" 4
+browser\.shortcuts\.newWindow: Ctrl+N
+.
+.IP "\(bu" 4
+browser\.shortcuts\.newTab: Ctrl+T
+.
+.IP "\(bu" 4
+browser\.shortcuts\.about: F1
+.
+.IP "\(bu" 4
+browser\.shortcuts\.quit: Ctrl+Q
+.
+.IP "\(bu" 4
+browser\.shortcuts\.back: Ctrl+Left
+.
+.IP "\(bu" 4
+browser\.shortcuts\.forward: Ctrl+Right
+.
+.IP "\(bu" 4
+browser\.shortcuts\.refresh: F5
+.
+.IP "\(bu" 4
+browser\.shortcuts\.reload: Ctrl+F5
+.
+.IP "\(bu" 4
+browser\.shortcuts\.home: Ctrl+Home
+.
+.IP "\(bu" 4
+browser\.shortcuts\.tabClose: Ctrl+X
+.
+.IP "\(bu" 4
+browser\.shortcuts\.tabLeft: Ctrl+O
+.
+.IP "\(bu" 4
+browser\.shortcuts\.tabRight: Ctrl+P
+.
+.IP "\(bu" 4
+browser\.shortcuts\.toggleSearchBox: F3
+.
+.IP "\(bu" 4
+browser\.shortcuts\.focusAddress: F4
+.
+.IP "\(bu" 4
+browser\.shortcuts\.fullscreen: F11
+.
+.IP "" 0
+.
+.SS "Filter settings"
+.
+.IP "\(bu" 4
+filter\.path: ~/\.config/smolbote/hosts\.d
+.
+.IP "" 0
+.
+.SS "Plugin settings"
+.
+.IP "\(bu" 4
+plugins\.path: ~/\.config/smolbote/plugins\.d
+.
+.IP "" 0
+.
+.SS "Profile settings"
+.
+.IP "\(bu" 4
+profile\.path: ~/\.config/smolbote/profiles\.d
+.
+.IP "\(bu" 4
+profile\.search: https://duckduckgo\.com/?q=$term&ia=web
+.
+.IP "\(bu" 4
+profile\.homepage: about:blank
+.
+.IP "\(bu" 4
+profile\.newtab: about:blank
+.
+.IP "" 0
+.
+.SS "Bookmark settings"
+.
+.IP "\(bu" 4
+bookmarks\.path: ~/\.config/smolbote/bookmarks\.xbel
.
-.TP
-\fB\-v\fR, \fB\-\-version\fR
-Displays version information\.
+.IP "\(bu" 4
+bookmarks\.shortcut: Ctrl+B
.
-.TP
-\fB\-c\fR, \fB\-\-config\fR
-Set configuration file\.
+.IP "" 0
.
-.TP
-\fB\-\-default\-config\fR
-Set the default configuration file\.
+.SS "Downloads settings"
.
-.TP
-\fB\-p\fR, \fB\-\-profile\fR
-Use this profile\.
+.IP "\(bu" 4
+downloads\.path: ~/Downloads
.
-.TP
-\fB\-\-socket\fR
-Local server socket
+.IP "\(bu" 4
+downloads\.shortcut: Ctrl+D
.
-.TP
-\fB\-\-in\-new\-window\fR
-Open URL in new window
+.IP "" 0
diff --git a/linux/man/smolbote.7.html b/linux/man/smolbote.7.html
index c251436..b857c40 100644
--- a/linux/man/smolbote.7.html
+++ b/linux/man/smolbote.7.html
@@ -55,7 +55,9 @@
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
+ <a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</a>
+ <a href="#CONFIGURATION">CONFIGURATION</a>
</div>
<ol class='man-decor man-head man head'>
@@ -73,23 +75,132 @@
<p><code>poi</code> [<var>options</var>...] URL</p>
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>smolbote is a keep-it-simple free software web browser.</p>
+
<h2 id="OPTIONS">OPTIONS</h2>
-<dl>
-<dt><code>-h</code>, <code>--help</code></dt><dd><p>Displays this help.</p></dd>
-<dt><code>-v</code>, <code>--version</code></dt><dd><p>Displays version information.</p></dd>
-<dt><code>-c</code>, <code>--config</code></dt><dd><p>Set configuration file.</p></dd>
-<dt><code>--default-config</code></dt><dd><p>Set the default configuration file.</p></dd>
-<dt><code>-p</code>, <code>--profile</code></dt><dd><p>Use this profile.</p></dd>
-<dt><code>--socket</code></dt><dd><p>Local server socket</p></dd>
-<dt><code>--in-new-window</code></dt><dd><p>Open URL in new window</p></dd>
-</dl>
+<h3 id="General">General</h3>
+
+<ul>
+<li><code>-h</code>, <code>--help</code>: Displays this help.</li>
+<li><code>-v</code>, <code>--version</code>: Displays version information.</li>
+<li><code>--build</code>: Displays build information.</li>
+</ul>
+
+
+<h3 id="Configuration">Configuration</h3>
+
+<ul>
+<li><code>-c</code>, <code>--config</code>: Set configuration file.</li>
+<li><code>--socket</code>: Local server socket</li>
+</ul>
+
+
+<h3 id="Open-URL">Open URL</h3>
+
+<ul>
+<li><code>-p</code>, <code>--profile</code>: Use this profile.</li>
+<li><code>--in-new-window</code>: Open URL in new window.</li>
+</ul>
+
+
+<h2 id="CONFIGURATION">CONFIGURATION</h2>
+
+<p>The Configuration is loaded from <em>~/.config/smolbote/smolbote.cfg</em>, and can be
+edited with the <code>poi-config</code> tool.</p>
+
+<p>Settings are only loaded on launch, so re-run the browser to apply changes.</p>
+
+<ul>
+<li>browser.profile: Profile to be used by default, "" is off-the-record</li>
+</ul>
+
+
+<h3 id="Default-window-size">Default window size</h3>
+
+<ul>
+<li>browser.window.height: 720</li>
+<li>browser.window.width: 1280</li>
+<li>browser.window.maximized: true</li>
+<li>browser.window.title: title — smolbote [profile]</li>
+</ul>
+
+
+<h3 id="Window-UI">Window UI</h3>
+
+<ul>
+<li>browser.ui.navtoolbarMovable: false</li>
+<li>browser.ui.tabtoolbarMovable: false</li>
+</ul>
+
+
+<h3 id="Shortcuts">Shortcuts</h3>
+
+<ul>
+<li>browser.shortcuts.newWindow: Ctrl+N</li>
+<li>browser.shortcuts.newTab: Ctrl+T</li>
+<li>browser.shortcuts.about: F1</li>
+<li><p>browser.shortcuts.quit: Ctrl+Q</p></li>
+<li><p>browser.shortcuts.back: Ctrl+Left</p></li>
+<li>browser.shortcuts.forward: Ctrl+Right</li>
+<li>browser.shortcuts.refresh: F5</li>
+<li>browser.shortcuts.reload: Ctrl+F5</li>
+<li><p>browser.shortcuts.home: Ctrl+Home</p></li>
+<li><p>browser.shortcuts.tabClose: Ctrl+X</p></li>
+<li>browser.shortcuts.tabLeft: Ctrl+O</li>
+<li><p>browser.shortcuts.tabRight: Ctrl+P</p></li>
+<li><p>browser.shortcuts.toggleSearchBox: F3</p></li>
+<li>browser.shortcuts.focusAddress: F4</li>
+<li>browser.shortcuts.fullscreen: F11</li>
+</ul>
+
+
+<h3 id="Filter-settings">Filter settings</h3>
+
+<ul>
+<li>filter.path: ~/.config/smolbote/hosts.d</li>
+</ul>
+
+
+<h3 id="Plugin-settings">Plugin settings</h3>
+
+<ul>
+<li>plugins.path: ~/.config/smolbote/plugins.d</li>
+</ul>
+
+
+<h3 id="Profile-settings">Profile settings</h3>
+
+<ul>
+<li>profile.path: ~/.config/smolbote/profiles.d</li>
+<li>profile.search: https://duckduckgo.com/?q=$term&amp;ia=web</li>
+<li>profile.homepage: about:blank</li>
+<li>profile.newtab: about:blank</li>
+</ul>
+
+
+<h3 id="Bookmark-settings">Bookmark settings</h3>
+
+<ul>
+<li>bookmarks.path: ~/.config/smolbote/bookmarks.xbel</li>
+<li>bookmarks.shortcut: Ctrl+B</li>
+</ul>
+
+
+<h3 id="Downloads-settings">Downloads settings</h3>
+
+<ul>
+<li>downloads.path: ~/Downloads</li>
+<li>downloads.shortcut: Ctrl+D</li>
+</ul>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
- <li class='tc'>February 2018</li>
+ <li class='tc'>March 2018</li>
<li class='tr'>smolbote(7)</li>
</ol>
diff --git a/linux/man/smolbote.7.ronn b/linux/man/smolbote.7.ronn
index ece9697..c1e9aa0 100644
--- a/linux/man/smolbote.7.ronn
+++ b/linux/man/smolbote.7.ronn
@@ -5,25 +5,80 @@ smolbote(7) -- yet another no-frills browser
`poi` [<options>...] URL
+## DESCRIPTION
+
+smolbote is a keep-it-simple free software web browser.
+
## OPTIONS
-* `-h`, `--help`:
-Displays this help.
+### General
+* `-h`, `--help`: Displays this help.
+* `-v`, `--version`: Displays version information.
+* `--build`: Displays build information.
+
+### Configuration
+* `-c`, `--config`: Set configuration file.
+* `--socket`: Local server socket
+
+### Open URL
+* `-p`, `--profile`: Use this profile.
+* `--in-new-window`: Open URL in new window.
+
+## CONFIGURATION
+
+The Configuration is loaded from _~/.config/smolbote/smolbote.cfg_, and can be
+edited with the `poi-config` tool.
+
+Settings are only loaded on launch, so re-run the browser to apply changes.
+
+* browser.profile: Profile to be used by default, "" is off-the-record
+
+### Default window size
+* browser.window.height: 720
+* browser.window.width: 1280
+* browser.window.maximized: true
+* browser.window.title: title — smolbote [profile]
+
+### Window UI
+* browser.ui.navtoolbarMovable: false
+* browser.ui.tabtoolbarMovable: false
+
+### Shortcuts
+* browser.shortcuts.newWindow: Ctrl+N
+* browser.shortcuts.newTab: Ctrl+T
+* browser.shortcuts.about: F1
+* browser.shortcuts.quit: Ctrl+Q
+
+* browser.shortcuts.back: Ctrl+Left
+* browser.shortcuts.forward: Ctrl+Right
+* browser.shortcuts.refresh: F5
+* browser.shortcuts.reload: Ctrl+F5
+* browser.shortcuts.home: Ctrl+Home
+
+* browser.shortcuts.tabClose: Ctrl+X
+* browser.shortcuts.tabLeft: Ctrl+O
+* browser.shortcuts.tabRight: Ctrl+P
-* `-v`, `--version`:
-Displays version information.
+* browser.shortcuts.toggleSearchBox: F3
+* browser.shortcuts.focusAddress: F4
+* browser.shortcuts.fullscreen: F11
-* `-c`, `--config`:
-Set configuration file.
+### Filter settings
+* filter.path: ~/.config/smolbote/hosts.d
-* `--default-config`:
-Set the default configuration file.
+### Plugin settings
+* plugins.path: ~/.config/smolbote/plugins.d
-* `-p`, `--profile`:
-Use this profile.
+### Profile settings
+* profile.path: ~/.config/smolbote/profiles.d
+* profile.search: https://duckduckgo.com/?q=$term&ia=web
+* profile.homepage: about:blank
+* profile.newtab: about:blank
-* `--socket`:
-Local server socket
+### Bookmark settings
+* bookmarks.path: ~/.config/smolbote/bookmarks.xbel
+* bookmarks.shortcut: Ctrl+B
-* `--in-new-window`:
-Open URL in new window
+### Downloads settings
+* downloads.path: ~/Downloads
+* downloads.shortcut: Ctrl+D