aboutsummaryrefslogtreecommitdiff
path: root/linux
diff options
context:
space:
mode:
Diffstat (limited to 'linux')
-rw-r--r--linux/makepkg/PKGBUILD24
-rw-r--r--linux/man/manpage.md8
-rw-r--r--linux/man/smolbote.7226
-rw-r--r--linux/man/smolbote.7.html252
-rw-r--r--linux/man/smolbote.md (renamed from linux/man/smolbote.7.ronn)11
5 files changed, 18 insertions, 503 deletions
diff --git a/linux/makepkg/PKGBUILD b/linux/makepkg/PKGBUILD
index d0e3b7f..cd21909 100644
--- a/linux/makepkg/PKGBUILD
+++ b/linux/makepkg/PKGBUILD
@@ -14,7 +14,7 @@ replaces=('smolbote-git')
depends=('qt5-webengine>=5.10.1' 'boost-libs>=1.66.0')
optdepends=('firejail: launch a sandboxed instance')
-makedepends=('mercurial' 'cmake' 'pkg-config' 'ninja')
+makedepends=('mercurial' 'cmake' 'pkg-config' 'go-md2man')
# this is the central repository
source=("smolbote-hg::hg+https://neueland.iserlohn-fortress.net/smolbote.hg")
@@ -29,7 +29,7 @@ prepare() {
# go into src/smolbote-hg
cd smolbote-hg
- msg "Verifying integrity"
+ msg2 "Verifying integrity"
# get commit id
_node="$(hg log -r tip --template='{node}')"
# download checksums and signature
@@ -46,11 +46,13 @@ pkgver() {
}
build() {
+ # clean build folder
# src/smolbote-hg-r000.123456789012
rm -rf "$pkgname-$pkgver"
mkdir "$pkgname-$pkgver"
cd "$pkgname-$pkgver"
+ msg2 "Building smolbote"
# CMake Options
# Build Type
# Debug builds don't have install rules.
@@ -73,23 +75,22 @@ build() {
# this requires 'extra-cmake-modules'
#_cmake_options="$_cmake_options -DPlasma=On"
- # Build System
- # Flavour: I use ninja, but you can comment this out, or set your own
- # flavour. Don't forget to change the Build and Install though!
- _cmake_options="$_cmake_options -GNinja"
-
# Generate Makefile
cmake $_cmake_options "$srcdir/smolbote-hg"
# Build
- ninja
+ make
+
+ msg2 "Generating manpage"
+ go-md2man -in $srcdir/smolbote-hg/linux/man/smolbote.md -out smolbote.7
+ gzip smolbote.7
}
package() {
cd "$pkgname-$pkgver"
# Install
- ninja install
+ make install
# icon and .desktop
install -Dm644 "${srcdir}/smolbote-hg/data/poi.svg" "${pkgdir}/usr/share/icons/hicolor/scalable/apps/poi.svg"
@@ -99,7 +100,6 @@ package() {
install -Dm644 "${srcdir}/smolbote-hg/data/poi.profile" "${pkgdir}/usr/local/lib/smolbote/poi.profile"
# man page
- _man_dir="$pkgdir/usr/local/man/man7"
- test -d $_man_dir || mkdir -p $_man_dir
- gzip --keep --to-stdout "$srcdir/smolbote-hg/linux/man/smolbote.7" > "$_man_dir/smolbote.7.gz"
+ install -Dm644 smolbote.7.gz $pkgdir/usr/local/man/man7/smolbote.7.gz
}
+
diff --git a/linux/man/manpage.md b/linux/man/manpage.md
deleted file mode 100644
index deb06fd..0000000
--- a/linux/man/manpage.md
+++ /dev/null
@@ -1,8 +0,0 @@
-To generate the manpage, use ronn:
-
-~~~sh
-## install
-gem install --user-install ronn
-## generate
-ronn smolbote.7.ronn
-~~~
diff --git a/linux/man/smolbote.7 b/linux/man/smolbote.7
deleted file mode 100644
index fe36a8d..0000000
--- a/linux/man/smolbote.7
+++ /dev/null
@@ -1,226 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "SMOLBOTE" "7" "June 2018" "" ""
-.
-.SH "NAME"
-\fBsmolbote\fR \- yet another no\-frills browser
-.
-.SH "SYNOPSIS"
-\fBpoi\fR [\fIoptions\fR\.\.\.] URL(s)
-.
-.SH "DESCRIPTION"
-smolbote is a keep\-it\-simple free software web browser\.
-.
-.SH "COMMAND\-LINE OPTIONS"
-.
-.SS "General"
-.
-.IP "\(bu" 4
-\fB\-h\fR, \fB\-\-help\fR: Display this help\.
-.
-.IP "\(bu" 4
-\fB\-v\fR, \fB\-\-version\fR: Display version information\.
-.
-.IP "\(bu" 4
-\fB\-\-build\fR: Display build branch and commit\.
-.
-.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 "Plugins"
-.
-.IP "\(bu" 4
-\fB\-\-command\fR: Run a plugin command\.
-.
-.IP "\(bu" 4
-\fB\-\-commands\fR: List all plugin commands\.
-.
-.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; 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
-.
-.IP "\(bu" 4
-mainwindow\.width: 1280
-.
-.IP "\(bu" 4
-mainwindow\.maximized: true
-.
-.IP "\(bu" 4
-mainwindow\.title: smolbote
-.
-.IP "\(bu" 4
-mainwindow\.shortcuts\.newGroup: Ctrl+G
-.
-.IP "\(bu" 4
-mainwindow\.shortcuts\.newWindow: Ctrl+N
-.
-.IP "\(bu" 4
-mainwindow\.shortcuts\.about: F1
-.
-.IP "\(bu" 4
-mainwindow\.shortcuts\.quit: Ctrl+Q
-.
-.IP "\(bu" 4
-mainwindow\.shortcuts\.search: F3
-.
-.IP "\(bu" 4
-mainwindow\.shortcuts\.tileWindows: F9
-.
-.IP "\(bu" 4
-mainwindow\.shortcuts\.cascadeWindows: F10
-.
-.IP "" 0
-.
-.SS "Subwindow"
-A subwindow contains multiple tabs and functions similarly to a tab group\.
-.
-.IP "\(bu" 4
-window\.shortcuts\.new: Ctrl+T
-.
-.IP "\(bu" 4
-window\.shortcuts\.close: Ctrl+X
-.
-.IP "\(bu" 4
-window\.shortcuts\.left: Ctrl+O
-.
-.IP "\(bu" 4
-window\.shortcuts\.right: Ctrl+P
-.
-.IP "\(bu" 4
-window\.shortcuts\.fullscreen: F11
-.
-.IP "" 0
-.
-.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
-navigation\.movable: false
-.
-.IP "\(bu" 4
-navigation\.shortcuts\.back: Ctrl+Left
-.
-.IP "\(bu" 4
-navigation\.shortcuts\.forward: Ctrl+Right
-.
-.IP "\(bu" 4
-navigation\.shortcuts\.refresh: F5
-.
-.IP "\(bu" 4
-navigation\.shortcuts\.reload: Ctrl+F5
-.
-.IP "\(bu" 4
-navigation\.shortcuts\.home: Ctrl+Home
-.
-.IP "" 0
-.
-.SS "Address bar"
-.
-.IP "\(bu" 4
-addressbar\.shortcuts\.focus: F4
-.
-.IP "\(bu" 4
-addressbar\.shortcuts\.menu: F2
-.
-.IP "" 0
-.
-.SS "Filter"
-.
-.IP "\(bu" 4
-filter\.path: ~/\.config/smolbote/hosts\.d
-.
-.IP "\(bu" 4
-filter\.cookies\.block\.all: false (todo: in qt5\.11)
-.
-.IP "\(bu" 4
-filter\.cookies\.block\.thirdParty: true
-.
-.IP "\(bu" 4
-filter\.cookies\.path: ~/\.config/smolbote/cookies\.d
-.
-.IP "" 0
-.
-.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, or set its absolute path as the plugins\.path\.
-.
-.IP "\(bu" 4
-plugins\.path: ~/\.config/smolbote/plugins\.d
-.
-.IP "" 0
-.
-.SS "Profiles"
-A Profile is a collection of settings, policies, scripts, cookies, cache and history\. Profiles can be used to isolate pages from each other\.
-.
-.P
-Each window has a default profile it uses when opening new tabs\. This can be set by the profile\.default option, and can be changed from the window\'s menu\. Additionally, tabs can have their profiles individually changed from their page menu\.
-.
-.P
-Because profiles store all their data separately, you can log in into the same site with a different account from each profile\. However, links opened into new tabs will still use the subwindow\'s default profile\. For example, you can set a profile to hold login information for a site, but all new tabs opened from that site would still be using the default off\-the\-record profile\.
-.
-.IP "\(bu" 4
-profile\.default: \'\'
-.
-.IP "\(bu" 4
-profile\.path: ~/\.config/smolbote/profiles\.d
-.
-.IP "\(bu" 4
-profile\.search: https://duckduckgo\.com/?q=%1&ia=web
-.
-.IP "\(bu" 4
-profile\.homepage: about:blank
-.
-.IP "\(bu" 4
-profile\.newtab: about:blank
-.
-.IP "" 0
-.
-.SS "Bookmarks"
-.
-.IP "\(bu" 4
-bookmarks\.path: ~/\.config/smolbote/bookmarks\.xbel
-.
-.IP "\(bu" 4
-bookmarks\.shortcut: Ctrl+B
-.
-.IP "" 0
-.
-.SS "Downloads"
-.
-.IP "\(bu" 4
-downloads\.path: ~/Downloads
-.
-.IP "\(bu" 4
-downloads\.shortcut: Ctrl+D
-.
-.IP "" 0
-
diff --git a/linux/man/smolbote.7.html b/linux/man/smolbote.7.html
deleted file mode 100644
index 5784c91..0000000
--- a/linux/man/smolbote.7.html
+++ /dev/null
@@ -1,252 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
- <meta http-equiv='content-type' value='text/html;charset=utf8'>
- <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
- <title>smolbote(7) - yet another no-frills browser</title>
- <style type='text/css' media='all'>
- /* style: man */
- body#manpage {margin:0}
- .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
- .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
- .mp h2 {margin:10px 0 0 0}
- .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
- .mp h3 {margin:0 0 0 4ex}
- .mp dt {margin:0;clear:left}
- .mp dt.flush {float:left;width:8ex}
- .mp dd {margin:0 0 0 9ex}
- .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
- .mp pre {margin-bottom:20px}
- .mp pre+h2,.mp pre+h3 {margin-top:22px}
- .mp h2+pre,.mp h3+pre {margin-top:5px}
- .mp img {display:block;margin:auto}
- .mp h1.man-title {display:none}
- .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
- .mp h2 {font-size:16px;line-height:1.25}
- .mp h1 {font-size:20px;line-height:2}
- .mp {text-align:justify;background:#fff}
- .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
- .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
- .mp u {text-decoration:underline}
- .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
- .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
- .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
- .mp b.man-ref {font-weight:normal;color:#434241}
- .mp pre {padding:0 4ex}
- .mp pre code {font-weight:normal;color:#434241}
- .mp h2+pre,h3+pre {padding-left:0}
- ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
- ol.man-decor {width:100%}
- ol.man-decor li.tl {text-align:left}
- ol.man-decor li.tc {text-align:center;letter-spacing:4px}
- ol.man-decor li.tr {text-align:right;float:right}
- </style>
-</head>
-<!--
- The following styles are deprecated and will be removed at some point:
- div#man, div#man ol.man, div#man ol.head, div#man ol.man.
-
- The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
- .man-navigation should be used instead.
--->
-<body id='manpage'>
- <div class='mp' id='man'>
-
- <div class='man-navigation' style='display:none'>
- <a href="#NAME">NAME</a>
- <a href="#SYNOPSIS">SYNOPSIS</a>
- <a href="#DESCRIPTION">DESCRIPTION</a>
- <a href="#COMMAND-LINE-OPTIONS">COMMAND-LINE OPTIONS</a>
- <a href="#CONFIGURATION">CONFIGURATION</a>
- </div>
-
- <ol class='man-decor man-head man head'>
- <li class='tl'>smolbote(7)</li>
- <li class='tc'></li>
- <li class='tr'>smolbote(7)</li>
- </ol>
-
- <h2 id="NAME">NAME</h2>
-<p class="man-name">
- <code>smolbote</code> - <span class="man-whatis">yet another no-frills browser</span>
-</p>
-
-<h2 id="SYNOPSIS">SYNOPSIS</h2>
-
-<p><code>poi</code> [<var>options</var>...] URL(s)</p>
-
-<h2 id="DESCRIPTION">DESCRIPTION</h2>
-
-<p>smolbote is a keep-it-simple free software web browser.</p>
-
-<h2 id="COMMAND-LINE-OPTIONS">COMMAND-LINE OPTIONS</h2>
-
-<h3 id="General">General</h3>
-
-<ul>
-<li><code>-h</code>, <code>--help</code>: Display this help.</li>
-<li><code>-v</code>, <code>--version</code>: Display version information.</li>
-<li><code>--build</code>: Display build branch and commit.</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="Plugins">Plugins</h3>
-
-<ul>
-<li><code>--command</code>: Run a plugin command.</li>
-<li><code>--commands</code>: List all plugin commands.</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; re-run the browser to apply changes.</p>
-
-<h3 id="Browser">Browser</h3>
-
-<ul>
-<li>browser.stylesheet: path</li>
-</ul>
-
-
-<h3 id="Main-Window">Main Window</h3>
-
-<p>A main window contains one or more subwindows.</p>
-
-<ul>
-<li>mainwindow.height: 720</li>
-<li>mainwindow.width: 1280</li>
-<li>mainwindow.maximized: true</li>
-<li>mainwindow.title: smolbote</li>
-<li>mainwindow.shortcuts.newGroup: Ctrl+G</li>
-<li>mainwindow.shortcuts.newWindow: Ctrl+N</li>
-<li>mainwindow.shortcuts.about: F1</li>
-<li>mainwindow.shortcuts.quit: Ctrl+Q</li>
-<li>mainwindow.shortcuts.search: F3</li>
-<li>mainwindow.shortcuts.tileWindows: F9</li>
-<li>mainwindow.shortcuts.cascadeWindows: F10</li>
-</ul>
-
-
-<h3 id="Subwindow">Subwindow</h3>
-
-<p>A subwindow contains multiple tabs and functions similarly to a tab group.</p>
-
-<ul>
-<li>window.shortcuts.new: Ctrl+T</li>
-<li>window.shortcuts.close: Ctrl+X</li>
-<li>window.shortcuts.left: Ctrl+O</li>
-<li>window.shortcuts.right: Ctrl+P</li>
-<li>window.shortcuts.fullscreen: F11</li>
-</ul>
-
-
-<h3 id="Navigation-bar">Navigation bar</h3>
-
-<p>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.</p>
-
-<ul>
-<li>navigation.movable: false</li>
-<li>navigation.shortcuts.back: Ctrl+Left</li>
-<li>navigation.shortcuts.forward: Ctrl+Right</li>
-<li>navigation.shortcuts.refresh: F5</li>
-<li>navigation.shortcuts.reload: Ctrl+F5</li>
-<li>navigation.shortcuts.home: Ctrl+Home</li>
-</ul>
-
-
-<h3 id="Address-bar">Address bar</h3>
-
-<ul>
-<li>addressbar.shortcuts.focus: F4</li>
-<li>addressbar.shortcuts.menu: F2</li>
-</ul>
-
-
-<h3 id="Filter">Filter</h3>
-
-<ul>
-<li>filter.path: ~/.config/smolbote/hosts.d</li>
-<li>filter.cookies.block.all: false (todo: in qt5.11)</li>
-<li>filter.cookies.block.thirdParty: true</li>
-<li>filter.cookies.path: ~/.config/smolbote/cookies.d</li>
-</ul>
-
-
-<h3 id="Plugins">Plugins</h3>
-
-<p>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>
-
-<p>To enable a plugin either copy it or symlink it in the plugins.path location,
-or set its absolute path as the plugins.path.</p>
-
-<ul>
-<li>plugins.path: ~/.config/smolbote/plugins.d</li>
-</ul>
-
-
-<h3 id="Profiles">Profiles</h3>
-
-<p>A Profile is a collection of settings, policies, scripts, cookies, cache and
-history. Profiles can be used to isolate pages from each other.</p>
-
-<p>Each window has a default profile it uses when opening new tabs. This can be
-set by the profile.default option, and can be changed from the window's menu.
-Additionally, tabs can have their profiles individually changed from their page
-menu.</p>
-
-<p>Because profiles store all their data separately, you can log in into the same
-site with a different account from each profile. However, links opened into new
-tabs will still use the subwindow's default profile. For example, you can set a
-profile to hold login information for a site, but all new tabs opened from that
-site would still be using the default off-the-record profile.</p>
-
-<ul>
-<li>profile.default: ''</li>
-<li>profile.path: ~/.config/smolbote/profiles.d</li>
-<li>profile.search: https://duckduckgo.com/?q=%1&amp;ia=web</li>
-<li>profile.homepage: about:blank</li>
-<li>profile.newtab: about:blank</li>
-</ul>
-
-
-<h3 id="Bookmarks">Bookmarks</h3>
-
-<ul>
-<li>bookmarks.path: ~/.config/smolbote/bookmarks.xbel</li>
-<li>bookmarks.shortcut: Ctrl+B</li>
-</ul>
-
-
-<h3 id="Downloads">Downloads</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'>June 2018</li>
- <li class='tr'>smolbote(7)</li>
- </ol>
-
- </div>
-</body>
-</html>
diff --git a/linux/man/smolbote.7.ronn b/linux/man/smolbote.md
index 98674b9..320b9c6 100644
--- a/linux/man/smolbote.7.ronn
+++ b/linux/man/smolbote.md
@@ -1,13 +1,14 @@
-smolbote(7) -- yet another no-frills browser
-====
+smolbote(7)
+===
-## SYNOPSIS
+## NAME
+smolbote - yet another no-frills web browser
+## SYNOPSIS
`poi` [<options>...] URL(s)
## DESCRIPTION
-
-smolbote is a keep-it-simple free software web browser.
+todo
## COMMAND-LINE OPTIONS