diff options
author | Aqua-sama <aqua@iserlohn-fortress.net> | 2018-10-03 16:48:26 +0200 |
---|---|---|
committer | Aqua-sama <aqua@iserlohn-fortress.net> | 2018-10-03 16:48:26 +0200 |
commit | ae2a713f26fd58f397aaf93242f24c85dee98a2b (patch) | |
tree | db69c96f6419e011cfc1c6e6081613d7a0f0d7cc /linux | |
parent | Subwindow: only keep tab history for restore tab action (diff) | |
download | smolbote-ae2a713f26fd58f397aaf93242f24c85dee98a2b.tar.xz |
Convert documentation into asciidoc from markdown
Diffstat (limited to 'linux')
-rw-r--r-- | linux/makepkg/PKGBUILD | 21 | ||||
-rw-r--r-- | linux/man/smolbote.md | 75 |
2 files changed, 10 insertions, 86 deletions
diff --git a/linux/makepkg/PKGBUILD b/linux/makepkg/PKGBUILD index 2e0e755..4bb7571 100644 --- a/linux/makepkg/PKGBUILD +++ b/linux/makepkg/PKGBUILD @@ -17,7 +17,7 @@ license=('GPL3') depends=('qt5-webengine>=5.11.0' 'boost-libs>=1.66.0') optdepends=('firejail: launch a sandboxed instance') -makedepends=('git' 'cmake' 'pkg-config' 'go-md2man') +makedepends=('git' 'cmake' 'pkg-config' 'asciidoc') # this is the central repository source=("git+https://neueland.iserlohn-fortress.net/gitea/aqua/smolbote.git" @@ -66,7 +66,6 @@ build() { -DVerDescribe=$_describe \ -DVerCommit=$_commit \ -DVerBranch=$_branch \ - -DBreakpad=On \ $srcdir/smolbote # Build @@ -77,16 +76,16 @@ package() { # Install make install - # icon and .desktop - install -Dm644 "${srcdir}/smolbote/data/poi.svg" "${pkgdir}/usr/share/icons/hicolor/scalable/apps/poi.svg" - install -Dm644 "${srcdir}/smolbote/linux/poi.desktop" "${pkgdir}/usr/share/applications/poi.desktop" + msg2 "Installing icon and .desktop" + install -Dm644 $srcdir/smolbote/data/poi.svg $pkgdir/usr/share/icons/hicolor/scalable/apps/poi.svg + install -Dm644 $srcdir/smolbote/linux/poi.desktop $pkgdir/usr/share/applications/poi.desktop - # firejail profile - install -Dm644 "${srcdir}/smolbote/data/poi.profile" "${pkgdir}/usr/local/lib/smolbote/poi.profile" + msg2 "Installing firejail profile" + install -Dm644 $srcdir/smolbote/data/poi.profile $pkgdir/usr/local/lib/smolbote/poi.profile - msg2 "Install manpage" - go-md2man -in $srcdir/smolbote/linux/man/smolbote.md -out smolbote.7 - gzip smolbote.7 - install -Dm644 smolbote.7.gz $pkgdir/usr/local/man/man7/smolbote.7.gz + msg2 "Installing manpage" + a2x --format=manpage $srcdir/doc/smolbote.7.asciidoc + gzip $srcdir/doc/smolbote.7 + install -Dm644 $srcdir/doc/smolbote.7.gz $pkgdir/usr/local/man/man7/smolbote.7.gz } diff --git a/linux/man/smolbote.md b/linux/man/smolbote.md deleted file mode 100644 index b9ea181..0000000 --- a/linux/man/smolbote.md +++ /dev/null @@ -1,75 +0,0 @@ -smolbote(7) -=== - -## NAME -smolbote - yet another no-frills web browser - -## SYNOPSIS -`poi` [<options>...] URL(s) - -## DESCRIPTION -smolbote is a cross-platform keep-it-simple free software web browser based on -Qt and QtWebEngine. - -## COMMAND-LINE OPTIONS - -### General -* `-h`, `--help`: Display this help. -* `-v`, `--version`: Display version information. -* `--build`: Display build branch and commit. -* `-c`, `--config`: Set configuration file. -* `--no-remote`: Don't check for other instances when starting. - -## CONFIGURATION - -The Configuration is loaded from _~/.config/smolbote/smolbote.cfg_. Most -settings are only loaded on launch. - -For a full list of settings, check `--help`. - -### Browser (group: browser) - -### Main Window (group: mainwindow) -A main window contains one or more subwindows. - -### Subwindow (group: window) -A subwindow contains multiple tabs and functions similarly to a tab group. - -### Navigation bar (group: navigation) -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. - -### Address bar (group: addressbar) - -### Filter (group: filter) - -### Plugins (group: 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, -or set its absolute path as the plugins.path. - -### Profiles (group: profile) -A Profile is a collection of settings, policies, scripts, cookies, cache and -history. Profiles can be used to isolate pages from each other. - -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. - -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. - -Profile definitions are stored in the profiles.path location. To create a new -profile, create a profile-id.profile file in that location. - -### Bookmarks (group: bookmarks) - -### Downloads (group: downloads) - |