From 13c36c432bcad740950d905629d0285c1037ed36 Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Fri, 18 May 2018 13:52:10 +0200 Subject: Update manpage --- linux/man/smolbote.7 | 79 +++++++++++++++++++++++++++----------------- linux/man/smolbote.7.html | 84 ++++++++++++++++++++++++++++++----------------- linux/man/smolbote.7.ronn | 61 +++++++++++++++++++++------------- 3 files changed, 139 insertions(+), 85 deletions(-) (limited to 'linux') diff --git a/linux/man/smolbote.7 b/linux/man/smolbote.7 index bd865e9..e8f63bd 100644 --- a/linux/man/smolbote.7 +++ b/linux/man/smolbote.7 @@ -1,29 +1,29 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "SMOLBOTE" "7" "April 2018" "" "" +.TH "SMOLBOTE" "7" "May 2018" "" "" . .SH "NAME" \fBsmolbote\fR \- yet another no\-frills browser . .SH "SYNOPSIS" -\fBpoi\fR [\fIoptions\fR\.\.\.] URL +\fBpoi\fR [\fIoptions\fR\.\.\.] URL(s) . .SH "DESCRIPTION" smolbote is a keep\-it\-simple free software web browser\. . -.SH "OPTIONS" +.SH "COMMAND\-LINE OPTIONS" . .SS "General" . .IP "\(bu" 4 -\fB\-h\fR, \fB\-\-help\fR: Displays this help\. +\fB\-h\fR, \fB\-\-help\fR: Display this help\. . .IP "\(bu" 4 -\fB\-v\fR, \fB\-\-version\fR: Displays version information\. +\fB\-v\fR, \fB\-\-version\fR: Display version information\. . .IP "\(bu" 4 -\fB\-\-build\fR: Displays build information\. +\fB\-\-build\fR: Display build branch and commit\. . .IP "" 0 . @@ -37,13 +37,13 @@ smolbote is a keep\-it\-simple free software web browser\. . .IP "" 0 . -.SS "Open URL" +.SS "Plugins" . .IP "\(bu" 4 -\fB\-p\fR, \fB\-\-profile\fR: Use this profile\. +\fB\-\-command\fR: Run a plugin command\. . .IP "\(bu" 4 -\fB\-\-in\-new\-window\fR: Open URL in new window\. +\fB\-\-commands\fR: List all plugin commands\. . .IP "" 0 . @@ -51,9 +51,17 @@ smolbote is a keep\-it\-simple free software web browser\. 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\. +Settings are only loaded on launch; re\-run the browser to apply changes\. +. +.SS "Browser" +. +.IP "\(bu" 4 +browser\.stylesheet: path +. +.IP "" 0 . .SS "Main Window" +A main window contains one or more subwindows\. . .IP "\(bu" 4 mainwindow\.height: 720 @@ -71,7 +79,7 @@ mainwindow\.title: smolbote mainwindow\.shortcuts\.newGroup: Ctrl+G . .IP "\(bu" 4 -mainwindow\.shortcuts\.newWindow: Ctrl+N (todo) +mainwindow\.shortcuts\.newWindow: Ctrl+N . .IP "\(bu" 4 mainwindow\.shortcuts\.about: F1 @@ -85,56 +93,61 @@ mainwindow\.shortcuts\.search: F3 .IP "\(bu" 4 mainwindow\.shortcuts\.tileWindows: F9 . +.IP "\(bu" 4 +mainwindow\.shortcuts\.cascadeWindows: F10 +. .IP "" 0 . -.SS "Navigation bar" +.SS "Subwindow" +A subwindow contains multiple tabs and functions similarly to a tab group\. . .IP "\(bu" 4 -navigation\.movable: false +window\.shortcuts\.new: Ctrl+T . .IP "\(bu" 4 -navigation\.shortcuts\.back: Ctrl+Left +window\.shortcuts\.close: Ctrl+X . .IP "\(bu" 4 -navigation\.shortcuts\.forward: Ctrl+Right +window\.shortcuts\.left: Ctrl+O . .IP "\(bu" 4 -navigation\.shortcuts\.refresh: F5 +window\.shortcuts\.right: Ctrl+P . .IP "\(bu" 4 -navigation\.shortcuts\.home: Ctrl+Home +window\.shortcuts\.fullscreen: F11 . .IP "" 0 . -.SS "Address bar" +.SS "Navigation bar" +The navigation bar is the toolbar that holds the history, reload and home buttons, as well as the address bar\. It can be made movable through the navigation\.movable option\. . .IP "\(bu" 4 -addressbar\.shortcuts\.focus: F4 +navigation\.movable: false . .IP "\(bu" 4 -addressbar\.shortcuts\.pageMenu: F2 +navigation\.shortcuts\.back: Ctrl+Left . .IP "\(bu" 4 -addressbar\.shortcuts\.toolsMenu: F10 -. -.IP "" 0 -. -.SS "Window" +navigation\.shortcuts\.forward: Ctrl+Right . .IP "\(bu" 4 -window\.shortcuts\.new: Ctrl+T +navigation\.shortcuts\.refresh: F5 . .IP "\(bu" 4 -window\.shortcuts\.close: Ctrl+X +navigation\.shortcuts\.reload: Ctrl+F5 . .IP "\(bu" 4 -window\.shortcuts\.left: Ctrl+O +navigation\.shortcuts\.home: Ctrl+Home +. +.IP "" 0 +. +.SS "Address bar" . .IP "\(bu" 4 -window\.shortcuts\.right: Ctrl+P +addressbar\.shortcuts\.focus: F4 . .IP "\(bu" 4 -window\.shortcuts\.fullscreen: F11 (todo) +addressbar\.shortcuts\.menu: F2 . .IP "" 0 . @@ -154,7 +167,11 @@ filter\.cookies\.path: ~/\.config/smolbote/cookies\.d . .IP "" 0 . -.SS "Plugins (to\-redo)" +.SS "Plugins" +Plugins a way of extending smolbote\'s functionality using the Qt plugin system\. They are not to be confused with NPAPI/PPAPI or WebExtension plugins\. +. +.P +To enable a plugin either copy it or symlink it in the plugins\.path location\. A set of default plugins is installed in /usr/lib/smolbote\. . .IP "\(bu" 4 plugins\.path: ~/\.config/smolbote/plugins\.d diff --git a/linux/man/smolbote.7.html b/linux/man/smolbote.7.html index a7c99f8..c74783f 100644 --- a/linux/man/smolbote.7.html +++ b/linux/man/smolbote.7.html @@ -56,7 +56,7 @@ NAME SYNOPSIS DESCRIPTION - OPTIONS + COMMAND-LINE OPTIONS CONFIGURATION @@ -73,20 +73,20 @@

SYNOPSIS

-

poi [options...] URL

+

poi [options...] URL(s)

DESCRIPTION

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

-

OPTIONS

+

COMMAND-LINE OPTIONS

General

@@ -98,11 +98,11 @@ -

Open URL

+

Plugins

@@ -111,31 +111,59 @@

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.

+

Settings are only loaded on launch; re-run the browser to apply changes.

+ +

Browser

+ + +

Main Window

+

A main window contains one or more subwindows.

+ + + +

Subwindow

+ +

A subwindow contains multiple tabs and functions similarly to a tab group.

+ + +

The navigation bar is the toolbar that holds the history, reload and home +buttons, as well as the address bar. It can be made movable through the +navigation.movable option.

+ @@ -144,19 +172,7 @@ edited with the poi-config tool.

- - -

Window

- - @@ -170,7 +186,13 @@ edited with the poi-config tool.

-

Plugins (to-redo)

+

Plugins

+ +

Plugins a way of extending smolbote's functionality using the Qt plugin system. +They are not to be confused with NPAPI/PPAPI or WebExtension plugins.

+ +

To enable a plugin either copy it or symlink it in the plugins.path location. A +set of default plugins is installed in /usr/lib/smolbote.