From: Armaan Bhojwani Date: Sun, 6 Jun 2021 16:33:54 +0000 (-0400) Subject: Fix man install path X-Git-Tag: v1.0.0~45 X-Git-Url: https://git.armaanb.net/?p=chorizo.git;a=commitdiff_plain;h=bba6462971d8c26f7c1b76b826ec1456def462e8 Fix man install path --- diff --git a/Makefile b/Makefile index cec3e11..f0e15d2 100644 --- a/Makefile +++ b/Makefile @@ -5,15 +5,15 @@ exec_prefix = $(prefix) bindir = $(exec_prefix)/bin libdir = $(exec_prefix)/lib datarootdir = $(prefix)/share -mandir = $(datarootdir)/man/man1 +mandir = $(datarootdir)/man/ datadir = $(prefix)/share -.PHONY: man lariza extensions clean uninstall install +.PHONY: clean uninstall install all: man lariza extensions darkreader man: - for i in man1/*.scd; do \ + for i in man/*.scd; do \ printf "SCDOC\t%s\n" $$i; \ scdoc < $$i > $$(echo "$$i" | rev | cut -f 2- -d '.' | rev); \ done @@ -42,7 +42,8 @@ install: all $(DESTDIR)$(datadir)/lariza/user-scripts cp lariza $(DESTDIR)$(bindir)/lariza - cp man1/* $(DESTDIR)$(mandir)/ + cp man/*.1 $(DESTDIR)$(mandir)/man1/ + cp man/*.5 $(DESTDIR)$(mandir)/man5/ cp lariza.ini $(DESTDIR)/etc/lariza.ini cp -r extensions/*.so $(DESTDIR)$(libdir)/lariza/web_extensions/ cp -r user-scripts/* $(DESTDIR)$(datadir)/lariza/user-scripts/ @@ -50,7 +51,8 @@ install: all uninstall: rm -rf $(DESTDIR)$(bindir)/lariza \ $(DESTDIR)$(libdir)/lariza \ - $(DESTDIR)$(man1dir)/lariza* \ + $(DESTDIR)$(mandir)/man1/lariza* \ + $(DESTDIR)$(mandir)/man5/lariza* \ $(DESTDIR)$(datadir)/lariza \ $(DESTDIR)/lariza.ini diff --git a/man/lariza-config.5.scd b/man/lariza-config.5.scd new file mode 100644 index 0000000..6f16479 --- /dev/null +++ b/man/lariza-config.5.scd @@ -0,0 +1,183 @@ +lariza-config(5) + +# NAME +_lariza.ini_ - configuration file for *lariza*(1) + +# DESCRIPTION +_lariza.ini_ is the system configuration file for the lariza browser. The syntax +is the standard GTK ini format. An example is provided at _/etc/lariza.ini_, and +user configuration should go in _~/.config/lariza/lariza.ini_, or your +equivalent as set by $XDG_CONFIG_DIR. Settings must go under the relevant +subsection. + +# OPTIONS +## BROWSER +*accepted_language*++ + Type: string++ + Default: NULL++ + Set the accepted language header. + +*console_to_stdout*++ + Type: boolean++ + Default: false++ + Print the contents of the browser console to stdout. + +*cookie_policy*++ + Type: string++ + Default: "no_third_party"++ + Options: "all", "none", "no_third_party"++ + Determines what cookies are accepted. + +*history_file*++ + Type: string++ + Default: none++ + File that lariza should save history to. + +*homepage*++ + Type: string++ + Default: "about:blank"++ + Set the default URI for new tabs. + +*javascript_disabled*++ + Type: boolean++ + Default: false++ + Determines whether or not JavaScript is enabled by default. + +*search_engine*++ + Type: string++ + Default: "https://duckduckgo.com?q="++ + What search engine to use when searching with "w/". + +*spellcheck_disabled*++ + Type: boolean++ + Default: false++ + Disable spell checking. + +*spellcheck_language*++ + Type: string++ + Default: "en_US;"++ + Language to use for spell checking. + +*user_agent*++ + Type: string++ + Default: the WebKit default++ + Choose a custom user agent. + +## UI +*tab_width*++ + Type: integer++ + Default: 20++ + Width of each tab in characters. + +*zoom_level*++ + Type: double++ + Default: 1.0++ + Default zoom level of each page. + +## KEYBINDINGS +All of these keybindings are bound to Control + key. + +*download_manager*++ + Type: string++ + Default: y++ + Toggle the download manager. + +*history_back*++ + Type: string++ + Default: h++ + Go back in history. + +*history_forwards*++ + Type: string++ + Default: h++ + Go forwards in history. + +*location*++ + Type: string++ + Default: t++ + Select the URL. + +*quit*++ + Type: string++ + Default: g++ + Deselect everything and focus on the webpage. + +*reload*++ + Type: string++ + Default: e++ + Reload the current tab. + +*scroll_line_down*++ + Type: string++ + Default: j++ + Scroll down one line. + +*scroll_line_up*++ + Type: string++ + Default: k++ + Scroll up one line. + +*scroll_page_down*++ + Type: string++ + Default: f++ + Scroll down one page. + +*scroll_page_up*++ + Type: string++ + Default: b++ + Scroll up one page. + +*search_backwards*++ + Type: string++ + Default: r++ + Search in-page backwareds. + +*search_forwards*++ + Type: string++ + Default: s++ + Search in-page forwards. + +*tab_close*++ + Type: string++ + Default: q++ + Close the current tab. + +*tab_previous*++ + Type: string++ + Default: u++ + Focus the previous tab. + +*tab_new*++ + Type: string++ + Default: w++ + Open a new tab. + +*tab_next*++ + Type: string++ + Default: i++ + Focus the next tab. + +*toggle_js*++ + Type: string++ + Default: o++ + Toggle JavaScript. + +*web_search*++ + Type: string++ + Default: d++ + Start a web search. + +*zoom_in*++ + Type: string++ + Default: =++ + Zoom in 10%. + +*zoom_out*++ + Type: string++ + Default: -++ + Zoom out 10%. + +*zoom_reset*++ + Type: string++ + Default: -++ + Reset zoom to default. diff --git a/man/lariza-usage.1.scd b/man/lariza-usage.1.scd new file mode 100644 index 0000000..cadf89d --- /dev/null +++ b/man/lariza-usage.1.scd @@ -0,0 +1,81 @@ +lariza-usage(1) + +# NAME +lariza-usage - extended usage hints + +# DESCRIPTION +*lariza* is a simple web browser using GTK+ 3, GLib and WebKit2GTK+. This +manpage contains additional hints and pointers regarding its usage. + +# KEYBINDINGS AND CONFIGURATION +For this information, please refer to *lariza-configuration*(1). + +# DOWNLOAD MANAGER +Open the download manager using the appropriate hotkey. A new window listing +your downloads will appear. Clicking on an item will remove it from the list and +**if needed** cancel the download. + +There's no file manager integration, nor does *lariza* delete, overwrite or +resume downloads. If a file already exists, it won't be touched. Instead, the +new file name will have a suffix such as *.1*, *.2*, *.3*, and so on. + +# USER-SUPPLIED JAVASCRIPT FILES +After a page has been successfully loaded, the directory +_~/.config/lariza/user-scripts_ will be scanned and each file in it ending with +*.js* will be run as a JavaScript file in the context of said page. + +*lariza* comes with the following scripts: + +*hints.js* + Press *f* (open link in current window) or *F* (open in new window) to + activate link hints. After typing the characters for one of them, press + *Enter* to confirm. Press *Escape* to abort. + +*privacy-redirect.js* + Redirects YouTube, Reddit, etc to privacy respecting alternatives. + +*darkreader.js* + See https://darkreader.org. + +Those bundled scripts are automatically installed on *make install*. To use +them, though, make sure to link them to the directory mentioned above. + +# WEB EXTENSIONS +On startup, WebKit checks _~/.config/lariza/web_extensions_ for any *.so* +files. See + +this blog post for further information on these extensions. + +*lariza* comes with the following extensions: + +*we_adblock.so* + Generic adblock. Reads patterns from the file _~/.config/lariza/adblock_. Each + line can contain a regular expression. These expressions match + case-insensitive and partially, i.e.*\*foo.\** is the same as *.\*FOO.\** and + you can use anchors like *^https?://...*. Please refer to + https://developer.gnome.org/glib/stable/glib-regex-syntax.html the GLib + reference for more details. Lines starting with "#" are ignored. + + Those bundled web extensions are automatically compiled when you run *make* + and installed on *make install*. To use them, though, make sure to link them + to the directory mentioned above. + +# TRUSTED CERTIFICATES +By default, *lariza* trusts whatever CAs are trusted by WebKit. If you wish to +trust additional certificates, such as self-signed certificates, the first thing +you should do is try to add the appropriate CAs to your system-wide store. + +If you wish to add simple exceptions, you can grab the certificate and store it +in the directory _~/.config/lariza/certs_. The filename must be equal to the +hostname: + + $ echo | openssl s_client -connect foo.de:443 | openssl x509 >foo.de + +This tells *lariza* to trust the given certificate when connecting to host +*foo.de*. + +Note: This is NOT equal to certificate pinning. WebKit ignores user-specified +certificates if the server's certificate can be validated by any system-wide CA. + +# SEE ALSO +*lariza*(1), *lariza-config*(1) diff --git a/man/lariza.1.scd b/man/lariza.1.scd new file mode 100644 index 0000000..706446e --- /dev/null +++ b/man/lariza.1.scd @@ -0,0 +1,68 @@ +lariza(1) + +# NAME +lariza - simple web browser + +# SYNOPSIS +*lariza* - [-C] [_URI ..._] + +# DESCRIPTION +*lariza* is a simple web browser using GTK+ 3, GLib and WebKit2GTK+. + +# OPTIONS +In addition to the standard arguments of GTK+ 3, *lariza* knows about the +following options: + +*-C* + Disables cooperative instances. + +After these options there can be any number of URIs specified to open. + +# ENVIRONMENT +In addition to the standard variables of GTK+ 3, *lariza* knows about the +following environment variable: + +*LARIZA_FIFO_SUFFIX* + Cooperative instances are implemented using a named pipe in the file + system. The name of this pipe usually is (at least on modern systems following + XDG standards: /var/run/user/$UID/lariza.fifo-$LARIZA_FIFO_SUFFIX + + *$UID* is the id of your user. *$LARIZA_FIFO_SUFFIX* defaults to *main*. If you + change this variable, you can launch several independent cooperative instances + of *lariza*. + +# FILES +XDG variables will be used to construct these paths. +*~/.config/lariza/lariza.ini* + Configuration file. See *lariza-config*(5). + +*~/.config/lariza/adblock* + Adblock patterns. See *lariza-usage*(1). + +*~/.config/lariza/certs* + Directory where trusted certificates are stored. See *lariza-usage*(1). + +~/.config/lariza/user-scripts + Directory to store user-supplied JavaScript snippets. See *lariza-usage*(1). + +~/.local/share/lariza/web_extensions + Sets the directory where WebKit will look for web extensions. See + *lariza-usage*(1). + +~/.cache/lariza + +~/.cache/webkitgtk + +~/.local/share/webkitgtk + WebKitGTK will dump its caches and local storage here. It is probably wise to + clean those directories regularly or to mount them as *tmpfs*(5). + +# LICENSE +*lariza* is released under the MIT license. See the accompanying LICENSE file. + +# HISTORY +lariza was originally written by Peter Hofmann. The project was started in June +2014. This fork is maintained by Armaan Bhojwani. + +# SEE ALSO +*lariza-usage*(1), *lariza-config*(5) diff --git a/man1/lariza-config.5.scd b/man1/lariza-config.5.scd deleted file mode 100644 index aa71527..0000000 --- a/man1/lariza-config.5.scd +++ /dev/null @@ -1,173 +0,0 @@ -lariza-config(5) - -# NAME -_lariza.ini_ - configuration file for *lariza*(1) - -# DESCRIPTION -_lariza.ini_ is the system configuration file for the lariza browser. The syntax -is the standard GTK ini format. An example is provided at _/etc/lariza.ini_, and -user configuration should go in _~/.config/lariza/lariza.ini_, or your -equivalent as set by $XDG_CONFIG_DIR. Settings must go under the relevant -subsection. - -# OPTIONS -## BROWSER -*accepted_language*++ - Type: string++ - Default: NULL++ - Set the accepted language header. - -*console_to_stdout*++ - Type: boolean++ - Default: false++ - Print the contents of the browser console to stdout. - -*cookie_policy*++ - Type: string++ - Default: "no_third_party"++ - Options: "all", "none", "no_third_party"++ - Determines what cookies are accepted. - -*history_file*++ - Type: string++ - Default: none++ - File that lariza should save history to. - -*homepage*++ - Type: string++ - Default: "about:blank"++ - Set the default URI for new tabs. - -*javascript_disabled*++ - Type: boolean++ - Default: false++ - Determines whether or not JavaScript is enabled by default. - -*search_engine*++ - Type: string++ - Default: "https://duckduckgo.com?q="++ - What search engine to use when searching with "w/". - -*user_agent*++ - Type: string++ - Default: the WebKit default++ - Choose a custom user agent. - -## UI -*tab_width*++ - Type: integer++ - Default: 20++ - Width of each tab in characters. - -*zoom_level*++ - Type: double++ - Default: 1.0++ - Default zoom level of each page. - -## KEYBINDINGS -All of these keybindings are bound to Control + key. - -*download_manager*++ - Type: string++ - Default: y++ - Toggle the download manager. - -*history_back*++ - Type: string++ - Default: h++ - Go back in history. - -*history_forwards*++ - Type: string++ - Default: h++ - Go forwards in history. - -*location*++ - Type: string++ - Default: t++ - Select the URL. - -*quit*++ - Type: string++ - Default: g++ - Deselect everything and focus on the webpage. - -*reload*++ - Type: string++ - Default: e++ - Reload the current tab. - -*scroll_line_down*++ - Type: string++ - Default: j++ - Scroll down one line. - -*scroll_line_up*++ - Type: string++ - Default: k++ - Scroll up one line. - -*scroll_page_down*++ - Type: string++ - Default: f++ - Scroll down one page. - -*scroll_page_up*++ - Type: string++ - Default: b++ - Scroll up one page. - -*search_backwards*++ - Type: string++ - Default: r++ - Search in-page backwareds. - -*search_forwards*++ - Type: string++ - Default: s++ - Search in-page forwards. - -*tab_close*++ - Type: string++ - Default: q++ - Close the current tab. - -*tab_previous*++ - Type: string++ - Default: u++ - Focus the previous tab. - -*tab_new*++ - Type: string++ - Default: w++ - Open a new tab. - -*tab_next*++ - Type: string++ - Default: i++ - Focus the next tab. - -*toggle_js*++ - Type: string++ - Default: o++ - Toggle JavaScript. - -*web_search*++ - Type: string++ - Default: d++ - Start a web search. - -*zoom_in*++ - Type: string++ - Default: =++ - Zoom in 10%. - -*zoom_out*++ - Type: string++ - Default: -++ - Zoom out 10%. - -*zoom_reset*++ - Type: string++ - Default: -++ - Reset zoom to default. diff --git a/man1/lariza-usage.1.scd b/man1/lariza-usage.1.scd deleted file mode 100644 index cadf89d..0000000 --- a/man1/lariza-usage.1.scd +++ /dev/null @@ -1,81 +0,0 @@ -lariza-usage(1) - -# NAME -lariza-usage - extended usage hints - -# DESCRIPTION -*lariza* is a simple web browser using GTK+ 3, GLib and WebKit2GTK+. This -manpage contains additional hints and pointers regarding its usage. - -# KEYBINDINGS AND CONFIGURATION -For this information, please refer to *lariza-configuration*(1). - -# DOWNLOAD MANAGER -Open the download manager using the appropriate hotkey. A new window listing -your downloads will appear. Clicking on an item will remove it from the list and -**if needed** cancel the download. - -There's no file manager integration, nor does *lariza* delete, overwrite or -resume downloads. If a file already exists, it won't be touched. Instead, the -new file name will have a suffix such as *.1*, *.2*, *.3*, and so on. - -# USER-SUPPLIED JAVASCRIPT FILES -After a page has been successfully loaded, the directory -_~/.config/lariza/user-scripts_ will be scanned and each file in it ending with -*.js* will be run as a JavaScript file in the context of said page. - -*lariza* comes with the following scripts: - -*hints.js* - Press *f* (open link in current window) or *F* (open in new window) to - activate link hints. After typing the characters for one of them, press - *Enter* to confirm. Press *Escape* to abort. - -*privacy-redirect.js* - Redirects YouTube, Reddit, etc to privacy respecting alternatives. - -*darkreader.js* - See https://darkreader.org. - -Those bundled scripts are automatically installed on *make install*. To use -them, though, make sure to link them to the directory mentioned above. - -# WEB EXTENSIONS -On startup, WebKit checks _~/.config/lariza/web_extensions_ for any *.so* -files. See - -this blog post for further information on these extensions. - -*lariza* comes with the following extensions: - -*we_adblock.so* - Generic adblock. Reads patterns from the file _~/.config/lariza/adblock_. Each - line can contain a regular expression. These expressions match - case-insensitive and partially, i.e.*\*foo.\** is the same as *.\*FOO.\** and - you can use anchors like *^https?://...*. Please refer to - https://developer.gnome.org/glib/stable/glib-regex-syntax.html the GLib - reference for more details. Lines starting with "#" are ignored. - - Those bundled web extensions are automatically compiled when you run *make* - and installed on *make install*. To use them, though, make sure to link them - to the directory mentioned above. - -# TRUSTED CERTIFICATES -By default, *lariza* trusts whatever CAs are trusted by WebKit. If you wish to -trust additional certificates, such as self-signed certificates, the first thing -you should do is try to add the appropriate CAs to your system-wide store. - -If you wish to add simple exceptions, you can grab the certificate and store it -in the directory _~/.config/lariza/certs_. The filename must be equal to the -hostname: - - $ echo | openssl s_client -connect foo.de:443 | openssl x509 >foo.de - -This tells *lariza* to trust the given certificate when connecting to host -*foo.de*. - -Note: This is NOT equal to certificate pinning. WebKit ignores user-specified -certificates if the server's certificate can be validated by any system-wide CA. - -# SEE ALSO -*lariza*(1), *lariza-config*(1) diff --git a/man1/lariza.1.scd b/man1/lariza.1.scd deleted file mode 100644 index 706446e..0000000 --- a/man1/lariza.1.scd +++ /dev/null @@ -1,68 +0,0 @@ -lariza(1) - -# NAME -lariza - simple web browser - -# SYNOPSIS -*lariza* - [-C] [_URI ..._] - -# DESCRIPTION -*lariza* is a simple web browser using GTK+ 3, GLib and WebKit2GTK+. - -# OPTIONS -In addition to the standard arguments of GTK+ 3, *lariza* knows about the -following options: - -*-C* - Disables cooperative instances. - -After these options there can be any number of URIs specified to open. - -# ENVIRONMENT -In addition to the standard variables of GTK+ 3, *lariza* knows about the -following environment variable: - -*LARIZA_FIFO_SUFFIX* - Cooperative instances are implemented using a named pipe in the file - system. The name of this pipe usually is (at least on modern systems following - XDG standards: /var/run/user/$UID/lariza.fifo-$LARIZA_FIFO_SUFFIX - - *$UID* is the id of your user. *$LARIZA_FIFO_SUFFIX* defaults to *main*. If you - change this variable, you can launch several independent cooperative instances - of *lariza*. - -# FILES -XDG variables will be used to construct these paths. -*~/.config/lariza/lariza.ini* - Configuration file. See *lariza-config*(5). - -*~/.config/lariza/adblock* - Adblock patterns. See *lariza-usage*(1). - -*~/.config/lariza/certs* - Directory where trusted certificates are stored. See *lariza-usage*(1). - -~/.config/lariza/user-scripts - Directory to store user-supplied JavaScript snippets. See *lariza-usage*(1). - -~/.local/share/lariza/web_extensions - Sets the directory where WebKit will look for web extensions. See - *lariza-usage*(1). - -~/.cache/lariza - -~/.cache/webkitgtk - -~/.local/share/webkitgtk - WebKitGTK will dump its caches and local storage here. It is probably wise to - clean those directories regularly or to mount them as *tmpfs*(5). - -# LICENSE -*lariza* is released under the MIT license. See the accompanying LICENSE file. - -# HISTORY -lariza was originally written by Peter Hofmann. The project was started in June -2014. This fork is maintained by Armaan Bhojwani. - -# SEE ALSO -*lariza-usage*(1), *lariza-config*(5)