From 03ff56c3be7f5eda19309a60dccb281c76d0187f Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Tue, 20 Mar 2018 16:49:08 +0100 Subject: Update manpage --- linux/man/smolbote.7 | 188 ++++++++++++++++++++++++++++++++++++++++------ linux/man/smolbote.7.html | 131 +++++++++++++++++++++++++++++--- linux/man/smolbote.7.ronn | 83 ++++++++++++++++---- src/commandline.cpp | 3 - src/commandline.h | 1 - src/main.cpp | 10 +-- 6 files changed, 357 insertions(+), 59 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 @@
    @@ -73,23 +75,132 @@

    poi [options...] URL

    +

    DESCRIPTION

    + +

    smolbote is a keep-it-simple free software web browser.

    +

    OPTIONS

    -
    -
    -h, --help

    Displays this help.

    -
    -v, --version

    Displays version information.

    -
    -c, --config

    Set configuration file.

    -
    --default-config

    Set the default configuration file.

    -
    -p, --profile

    Use this profile.

    -
    --socket

    Local server socket

    -
    --in-new-window

    Open URL in new window

    -
    +

    General

    + + + + +

    Configuration

    + + + + +

    Open URL

    + + + + +

    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.

    + + + + +

    Default window size

    + + + + +

    Window UI

    + + + + +

    Shortcuts

    + + + + +

    Filter settings

    + + + + +

    Plugin settings

    + + + + +

    Profile settings

    + + + + +

    Bookmark settings

    + + + + +

    Downloads settings

    + +
    1. -
    2. February 2018
      3. +
    3. March 2018
    4. smolbote(7)
    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` [...] 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 diff --git a/src/commandline.cpp b/src/commandline.cpp index e7eec5d..2a0de69 100644 --- a/src/commandline.cpp +++ b/src/commandline.cpp @@ -50,7 +50,6 @@ CommandLine::CommandLine() , versionOption(addVersionOption()) , buildOption("build", "Show build information.") , configOption({ "c", "config" }, "Set configuration file.", "path", defaultUserConfigLocation()) - , defaultConfigOption("default-config", "Set the default configuration file.", "path", "") , profileOption({ "p", "profile" }, "Use this profile.", "profile", "") , socketOption("socket", "Local server socket", "name", socketPath()) , newWindowOption("in-new-window", "Open URL in new window") @@ -59,7 +58,6 @@ CommandLine::CommandLine() addOption(buildOption); addOption(configOption); - addOption(defaultConfigOption); addOption(profileOption); addOption(socketOption); addOption(newWindowOption); @@ -110,7 +108,6 @@ void CommandLine::printHelp(int exitCode) printOption(versionOption); printOption(buildOption); printOption(configOption); - printOption(defaultConfigOption); printOption(profileOption); printOption(socketOption); printOption(newWindowOption); diff --git a/src/commandline.h b/src/commandline.h index d7416b7..f27041e 100644 --- a/src/commandline.h +++ b/src/commandline.h @@ -26,7 +26,6 @@ public: const QCommandLineOption buildOption; const QCommandLineOption configOption; - const QCommandLineOption defaultConfigOption; const QCommandLineOption profileOption; const QCommandLineOption socketOption; const QCommandLineOption newWindowOption; diff --git a/src/main.cpp b/src/main.cpp index dfaad50..102ac8e 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -34,7 +34,6 @@ int main(int argc, char **argv) #ifdef QT_DEBUG qDebug("config=%s", qUtf8Printable(parser.value(parser.configOption))); - qDebug("default-config=%s", qUtf8Printable(parser.value(parser.defaultConfigOption))); qDebug("profile=%s", qUtf8Printable(parser.value(parser.profileOption))); qDebug("socket=%s", qUtf8Printable(parser.value(parser.socketOption))); @@ -42,14 +41,7 @@ int main(int argc, char **argv) std::shared_ptr config = std::make_shared(); - // first load the default configuration - if(!parser.value(parser.defaultConfigOption).isEmpty()) { - qDebug("Reading default configuration [%s]: %s", - qUtf8Printable(parser.value(parser.defaultConfigOption)), - config->read(parser.value(parser.defaultConfigOption)) ? "ok" : "failed"); - } - - // then load in the user configuration, which will overwrite it + // load user configuration if(!parser.value(parser.configOption).isEmpty()) { qDebug("Reading configuration [%s]: %s", qUtf8Printable(parser.value(parser.configOption)), -- cgit v1.2.1