From 34bf7efcd2ece2b0d5f96183da4e79d4258fe559 Mon Sep 17 00:00:00 2001 From: Aqua-sama Date: Sun, 30 Dec 2018 14:31:36 +0100 Subject: Add smolbote.5 manpage Configuration file and Options description manpage --- .gitignore | 4 ++ doc/meson.build | 14 +++++++ doc/smolbote.5.asciidoc | 106 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 124 insertions(+) create mode 100644 doc/smolbote.5.asciidoc diff --git a/.gitignore b/.gitignore index 2ae32dd..7551bc0 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,7 @@ test/plugins.d .config.old +# manpages +doc/smolbote.5 +doc/smolbote.7 + diff --git a/doc/meson.build b/doc/meson.build index 6e51e39..d45aea1 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -11,4 +11,18 @@ if get_option('manpage').enabled() install: true, install_dir: join_paths(get_option('mandir'), 'man7') ) + custom_target('manpage.5', + # list of files this target depends on + depend_files: ['smolbote.5.asciidoc'], + + input: 'smolbote.5.asciidoc', + output: 'smolbote.5', + + command: [asciidoctor, '--backend=manpage', '--out-file=@OUTPUT@', '@INPUT@'], + + build_by_default: true, + install: true, + install_dir: get_option('mandir') / 'man5' + ) + endif diff --git a/doc/smolbote.5.asciidoc b/doc/smolbote.5.asciidoc new file mode 100644 index 0000000..6b48def --- /dev/null +++ b/doc/smolbote.5.asciidoc @@ -0,0 +1,106 @@ += smolbote(5) +:doctype: manpage +:man source: smolbote configuration +:man manual: smolbote configuration manpage +:toc: +:homepage: https://neueland.iserlohn-fortress.net/smolbote/ + +== Name +smolbote - configuration file and options description + +== Description +The smolbote configuration is loaded at startup, and is not reloaded when +changed. By default (without any plugins), the browser does not change its +configuration or overwrite this file. Thus, it can be made read-only. + +The settings in this file change your preferences and keybindings. + +Lines starting with *#* are considered comments and ignored. + +== Sections + +=== Browser Options + +*browser.stylesheet* (arg):: TODO + +*browser.iconTheme* (arg):: +Set arg as icon theme. + +*browser.locale* (arg):: +Set Qt localization. This will translate Qt strings, such as the dialog buttons. +For possible values see `/usr/share/qt/translations`. + +*browser.translation* (arg):: +Set browser localization. This will translate the rest of the browser. For +possible values, see `install-root/share/smolbote/lang`. + +*browser.session.path* (arg=~/.config/smolbote/session.d):: +Location where browser sessions should be saved and loaded from by default. + +*plugins.path* (arg=~/.config/smolbote/plugins.d):: +Location where plugins should be loaded from. + +*bookmarks.path* (arg=~/.config/smolbote/bookmarks.xbel):: +Default bookmarks location. +*bookmarks.shortcut* (arg=Ctrl+B):: +Show/Hide bookmakrs widget shortcut. + +*downloads.path* (arg=~/Downloads):: +Default downloads location. +*downloads.shortcut* (arg=Ctrl+D):: +Show/Hide downloads widget shortcut. + +=== UI Options + +*mainwindow.height* (arg=720) +*mainwindow.width* (arg=1280) +*mainwindow.maximized* (arg=1):: Default window size and maximize toggle. + +*mainwindow.title* (arg=smolbote):: Default window title. + +*mainwindow.shortcuts.saveSession* (arg=Ctrl+S,S):: Save Session shortcut +*mainwindow.shortcuts.openSession* (arg=Ctrl+S,O):: Open Session shortcut +*mainwindow.shortcuts.newGroup* (arg=Ctrl+G):: New Group shortcut (subwindow) +*mainwindow.shortcuts.newWindow* (arg=Ctrl+N):: New Window shortcut +*mainwindow.shortcuts.about* (arg=F1):: About dialog shortcut +*mainwindow.shortcuts.quit* (arg=Ctrl+Q):: Quit shortcut +*mainwindow.shortcuts.search* (arg=F3):: Search in page shortcut +*mainwindow.shortcuts.tileWindows* (arg=F9):: Tile subwindows shortcut +*mainwindow.shortcuts.cascadeWindows* (arg=F10):: Cascade subwindows shortcut + +*navigation.movable* (arg=0):: Make navigation bar movable +*navigation.shortcuts.back* (arg=Ctrl+Left):: Back shortcut +*navigation.shortcuts.backMenu* (arg=Ctrl+Down):: Back menu shortcut +*navigation.shortcuts.forward* (arg=Ctrl+Right):: Forward shortcut +*navigation.shortcuts.forwardMenu* (arg=Ctrl+Up):: Forward menu shortcut +*navigation.shortcuts.refresh* (arg=F5):: Refresh shortcut +*navigation.shortcuts.reload* (arg=Ctrl+F5):: Reload shortcut +*navigation.shortcuts.home* (arg=Ctrl+Home):: Home shortcut + +*addressbar.shortcuts.focus* (arg=F4):: Focus on the address +*addressbar.shortcuts.menu* (arg=F2):: Show addressbar menu + +*subwindow.shortcuts.menu* (arg=Ctrl+M):: Show subwindow menu +*subwindow.shortcuts.new* (arg=Ctrl+T):: Create new tab shortcut +*subwindow.shortcuts.close* (arg=Ctrl+X):: Close tab shortcut +*subwindow.shortcuts.restoreTab* (arg=Ctrl+Shift+T):: Restore last closed tab +*subwindow.shortcuts.left* (arg=Ctrl+O):: Move to tab on the left +*subwindow.shortcuts.moveLeft* (arg=Ctrl+Shift+O):: Move tab to the left +*subwindow.shortcuts.right* (arg=Ctrl+P):: Move to tab on the right +*subwindow.shortcuts.moveRight* (arg=Ctrl+Shift+P):: Move tab to the right +*subwindow.shortcuts.fullscreen* (arg=F11):: Show page fullscreen + +=== Secutiry Options + +*filter.hosts* (arg=~/.config/smolbote/hosts.d):: Hostlist +*filter.adblock* arg:: TODO +*filter.header* arg:: +A list of HTTP headers to set. Each header should be given as a colon-separated +name:value pair. + +*profile.default* (arg):: Default browser profile +*profile.path* (arg=~/.config/smolbote/profiles.d):: Profile location +*profile.search* (arg=`https://duckduckgo.com/?q=%1&ia=web`):: +Default search engine. %1 is replaced by the search term. +*profile.homepage* (arg=`about:blank`):: Default homepage +*profile.newtab* (arg=`about:blank`):: Default new tab page -- cgit v1.2.1