mirror of
https://github.com/netsurf-browser/netsurf
synced 2024-12-16 09:12:44 +03:00
Update gtk manpage to mandoc format which is more portable
This commit is contained in:
Vincent Sanders
parent
959af3dc28
commit
6fa388d862
@ -1,366 +1,281 @@
|
||||
.\" Hey, EMACS: -*- nroff -*-
|
||||
.\" First parameter, NAME, should be all caps
|
||||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
||||
.\" other parameters are allowed: see man(7), man(1)
|
||||
.TH NETSURF 1 "December 24, 2014"
|
||||
.\" Please adjust this date whenever revising the manpage.
|
||||
.\" Copyright 2014 Vincent Sanders
|
||||
.\"
|
||||
.\" Some roff macros, for reference:
|
||||
.\" .nh disable hyphenation
|
||||
.\" .hy enable hyphenation
|
||||
.\" .ad l left justify
|
||||
.\" .ad b justify to both left and right margins
|
||||
.\" .nf disable filling
|
||||
.\" .fi enable filling
|
||||
.\" .br insert line break
|
||||
.\" .sp <n> insert n+1 empty lines
|
||||
.\" for manpage-specific macros, see man(7)
|
||||
.SH NAME
|
||||
netsurf \- A small fast web browser
|
||||
.SH SYNOPSIS
|
||||
.B netsurf-gtk
|
||||
.RI [ options ]
|
||||
.RI [ url ]
|
||||
.SH DESCRIPTION
|
||||
This manual page documents briefly the
|
||||
.B netsurf
|
||||
browser.
|
||||
.PP
|
||||
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
||||
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
|
||||
.\" respectively.
|
||||
\fBnetsurf\fP is a small fast web browser. This man page only describes how to run the browser.
|
||||
.SH OPTIONS
|
||||
This programs follow the usual GNU command line syntax, with long
|
||||
options starting with two dashes (`-').
|
||||
.PP
|
||||
The command line parameters override any options loaded from the users Choices file.
|
||||
.PP
|
||||
Additionally to these parameters the standard GTK+ options may be passed.
|
||||
.PP
|
||||
A summary of options is included below.
|
||||
.TP
|
||||
.B \-v
|
||||
.\" Permission is hereby granted, free of charge, to any person obtaining a copy of this man page (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
.\"
|
||||
.\"The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
.\"
|
||||
.\"THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
.Dd December 26, 2014
|
||||
.Dt NETSURF 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm netsurf
|
||||
.Nd a small fast web browser
|
||||
.Sh SYNOPSIS
|
||||
.Nm netsurf-gtk
|
||||
.Op Ar options
|
||||
.Op Ar url
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
is a lightweight, fast, standards-compliant web browser.
|
||||
This man page only describes how to run the browser.
|
||||
.Pp
|
||||
The command line parameters override any options loaded from the user's
|
||||
.Pa Choices
|
||||
file.
|
||||
.Pp
|
||||
In addition to these parameters the standard GTK+ options may be passed.
|
||||
.Pp
|
||||
The options are as follows:
|
||||
.Bl -tag -width Ds
|
||||
.It Fl v
|
||||
Enable verbose logging.
|
||||
.TP
|
||||
.B \-\-http_proxy
|
||||
Bboolean indicating if the http proxy is being used.
|
||||
.TP
|
||||
.B \-\-http_proxy_host
|
||||
.It Fl -http_proxy
|
||||
Boolean indicating if the http proxy is being used.
|
||||
.It Fl -http_proxy_host
|
||||
The http proxy host.
|
||||
.TP
|
||||
.B \-\-http_proxy_port
|
||||
.It Fl -http_proxy_port
|
||||
The http proxy port.
|
||||
.TP
|
||||
.B \-\-http_proxy_auth
|
||||
.It Fl -http_proxy_auth
|
||||
The authentication scheme for the http proxy.
|
||||
.TP
|
||||
.B \-\-http_proxy_auth_user
|
||||
.It Fl -http_proxy_auth_user
|
||||
The authentication schemes user.
|
||||
.TP
|
||||
.B \-\-http_proxy_auth_pass
|
||||
.It Fl -http_proxy_auth_pass
|
||||
The authentication schemes password.
|
||||
.TP
|
||||
.B \-\-font_size
|
||||
.It Fl -font_size
|
||||
The default font size to use.
|
||||
.TP
|
||||
.B \-\-font_min_size
|
||||
.It Fl -font_min_size
|
||||
The minimum font size to use.
|
||||
.TP
|
||||
.B \-\-font_sans
|
||||
.It Fl -font_sans
|
||||
Family name of the sans serif font.
|
||||
.TP
|
||||
.B \-\-font_serif
|
||||
.It Fl -font_serif
|
||||
Family name of the serif font.
|
||||
.TP
|
||||
.B \-\-font_mono
|
||||
.It Fl -font_mono
|
||||
Family name of the monospace font.
|
||||
.TP
|
||||
.B \-\-font_cursive
|
||||
.It Fl -font_cursive
|
||||
Family name of the cursive font.
|
||||
.TP
|
||||
.B \-\-font_fantasy
|
||||
.It Fl -font_fantasy
|
||||
Family name of the fantasy font.
|
||||
.TP
|
||||
.B \-\-accept_language
|
||||
.It Fl -accept_language
|
||||
Languages to accept.
|
||||
.TP
|
||||
.B \-\-accept_charset
|
||||
.It Fl -accept_charset
|
||||
Character set to accept
|
||||
.TP
|
||||
.B \-\-memory_cache_size
|
||||
.It Fl -memory_cache_size
|
||||
Maximum memory cache size.
|
||||
.TP
|
||||
.B \-\-disc_cache_age
|
||||
.It Fl -disc_cache_age
|
||||
Maximum disc cache size.
|
||||
.TP
|
||||
.B \-\-block_advertisements
|
||||
.It Fl -block_advertisements
|
||||
Boolean to enable ad blocking.
|
||||
.TP
|
||||
.B \-\-minimum_gif_delay
|
||||
.It Fl -minimum_gif_delay
|
||||
Minimum time between gif frames
|
||||
.TP
|
||||
.B \-\-send_referer
|
||||
.It Fl -send_referer
|
||||
Boolean controlling whether referrer data should be sent
|
||||
.TP
|
||||
.B \-\-animate_images
|
||||
.It Fl -animate_images
|
||||
Boolean controlling whether images should be animated.
|
||||
.TP
|
||||
.B \-\-expire_url
|
||||
.It Fl -expire_url
|
||||
expire url
|
||||
.TP
|
||||
.B \-\-font_default
|
||||
.It Fl -font_default
|
||||
Default font.
|
||||
.TP
|
||||
.B \-\-ca_bundle
|
||||
ca bundle
|
||||
.TP
|
||||
.B \-\-ca_path
|
||||
ca path
|
||||
.TP
|
||||
.B \-\-cookie_file
|
||||
.It Fl -ca_bundle
|
||||
Certificate authority bundle path.
|
||||
.It Fl -ca_path
|
||||
Certificate authority path
|
||||
.It Fl -cookie_file
|
||||
cookie file
|
||||
.TP
|
||||
.B \-\-cookie_jar
|
||||
.It Fl -cookie_jar
|
||||
cookie jar
|
||||
.TP
|
||||
.B \-\-homepage_url
|
||||
.It Fl -homepage_url
|
||||
homepage url
|
||||
.TP
|
||||
.B \-\-search_url_bar
|
||||
.It Fl -search_url_bar
|
||||
search url bar
|
||||
.TP
|
||||
.B \-\-search_provider
|
||||
.It Fl -search_provider
|
||||
search provider
|
||||
.TP
|
||||
.B \-\-url_suggestion
|
||||
.It Fl -url_suggestion
|
||||
url suggestion
|
||||
.TP
|
||||
.B \-\-window_x
|
||||
.It Fl -window_x
|
||||
The X co-ordinate of the initial window.
|
||||
.TP
|
||||
.B \-\-window_y
|
||||
.It Fl -window_y
|
||||
The Y co-ordinate of the initial window.
|
||||
.TP
|
||||
.B \-\-window_width
|
||||
.It Fl -window_width
|
||||
The width of the initial window.
|
||||
.TP
|
||||
.B \-\-window_height
|
||||
.It Fl -window_height
|
||||
The height of the initial window.
|
||||
.TP
|
||||
.B \-\-window_screen_width
|
||||
.It Fl -window_screen_width
|
||||
window screen width
|
||||
.TP
|
||||
.B \-\-window_screen_height
|
||||
.It Fl -window_screen_height
|
||||
window screen height
|
||||
.TP
|
||||
.B \-\-toolbar_status_size
|
||||
.It Fl -toolbar_status_size
|
||||
toolbar status size
|
||||
.TP
|
||||
.B \-\-scale
|
||||
.It Fl -scale
|
||||
Initial scale factor.
|
||||
.TP
|
||||
.B \-\-incremental_reflow
|
||||
.It Fl -incremental_reflow
|
||||
Boolean controlling whether incremental reflow is performed.
|
||||
.TP
|
||||
.B \-\-min_reflow_period
|
||||
.It Fl -min_reflow_period
|
||||
Minimum time between incremental reflows
|
||||
.TP
|
||||
.B \-\-core_select_menu
|
||||
.It Fl -core_select_menu
|
||||
core select menu
|
||||
.TP
|
||||
.B \-\-max_fetchers
|
||||
.It Fl -max_fetchers
|
||||
max fetchers
|
||||
.TP
|
||||
.B \-\-max_fetchers_per_host
|
||||
.It Fl -max_fetchers_per_host
|
||||
max fetchers per host
|
||||
.TP
|
||||
.B \-\-max_cached_fetch_handles
|
||||
.It Fl -max_cached_fetch_handles
|
||||
max cached fetch handles
|
||||
.TP
|
||||
.B \-\-suppress_curl_debug
|
||||
.It Fl -suppress_curl_debug
|
||||
suppress curl debug
|
||||
.TP
|
||||
.B \-\-target_blank
|
||||
.It Fl -target_blank
|
||||
target blank
|
||||
.TP
|
||||
.B \-\-button_2_tab
|
||||
.It Fl -button_2_tab
|
||||
button 2 tab
|
||||
.TP
|
||||
.B \-\-margin_top
|
||||
.It Fl -margin_top
|
||||
margin top
|
||||
.TP
|
||||
.B \-\-margin_bottom
|
||||
.It Fl -margin_bottom
|
||||
margin bottom
|
||||
.TP
|
||||
.B \-\-margin_left
|
||||
.It Fl -margin_left
|
||||
margin left
|
||||
.TP
|
||||
.B \-\-margin_right
|
||||
.It Fl -margin_right
|
||||
margin right
|
||||
.TP
|
||||
.B \-\-export_scale
|
||||
.It Fl -export_scale
|
||||
export scale
|
||||
.TP
|
||||
.B \-\-suppress_images
|
||||
.It Fl -suppress_images
|
||||
suppress images
|
||||
.TP
|
||||
.B \-\-remove_backgrounds
|
||||
.It Fl -remove_backgrounds
|
||||
remove backgrounds
|
||||
.TP
|
||||
.B \-\-enable_loosening
|
||||
.It Fl -enable_loosening
|
||||
enable loosening
|
||||
.TP
|
||||
.B \-\-enable_PDF_compression
|
||||
.It Fl -enable_PDF_compression
|
||||
enable PDF compression
|
||||
.TP
|
||||
.B \-\-enable_PDF_password
|
||||
.It Fl -enable_PDF_password
|
||||
enable_PDF_password
|
||||
.TP
|
||||
.B \-\-gui_colour_bg_1
|
||||
.It Fl -gui_colour_bg_1
|
||||
gui colour bg_1
|
||||
.TP
|
||||
.B \-\-gui_colour_fg_1
|
||||
.It Fl -gui_colour_fg_1
|
||||
gui colour fg_1
|
||||
.TP
|
||||
.B \-\-gui_colour_fg_2
|
||||
.It Fl -gui_colour_fg_2
|
||||
gui colour fg_2
|
||||
.TP
|
||||
.B \-\-sys_colour_ActiveBorder
|
||||
.It Fl -sys_colour_ActiveBorder
|
||||
Override CSS sys_colour_ActiveBorder colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ActiveCaption
|
||||
.It Fl -sys_colour_ActiveCaption
|
||||
Override CSS sys_colour_ActiveCaption colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_AppWorkspace
|
||||
.It Fl -sys_colour_AppWorkspace
|
||||
Override CSS sys_colour_AppWorkspace colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_Background
|
||||
.It Fl -sys_colour_Background
|
||||
Override CSS sys_colour_Background colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ButtonFace
|
||||
.It Fl -sys_colour_ButtonFace
|
||||
Override CSS sys_colour_ButtonFace colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ButtonHighlight
|
||||
.It Fl -sys_colour_ButtonHighlight
|
||||
Override CSS sys_colour_ButtonHighlight colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ButtonShadow
|
||||
.It Fl -sys_colour_ButtonShadow
|
||||
Override CSS sys_colour_ButtonShadow colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ButtonText
|
||||
.It Fl -sys_colour_ButtonText
|
||||
Override CSS sys_colour_ButtonText colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_CaptionText
|
||||
.It Fl -sys_colour_CaptionText
|
||||
Override CSS sys_colour_CaptionText colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_GrayText
|
||||
.It Fl -sys_colour_GrayText
|
||||
Override CSS sys_colour_GrayText colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_Highlight
|
||||
.It Fl -sys_colour_Highlight
|
||||
Override CSS sys_colour_Highlight colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_HighlightText
|
||||
.It Fl -sys_colour_HighlightText
|
||||
Override CSS sys_colour_HighlightText colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_InactiveBorder
|
||||
.It Fl -sys_colour_InactiveBorder
|
||||
Override CSS sys_colour_InactiveBorder colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_InactiveCaption
|
||||
.It Fl -sys_colour_InactiveCaption
|
||||
Override CSS sys_colour_InactiveCaption colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_InactiveCaptionText
|
||||
.It Fl -sys_colour_InactiveCaptionText
|
||||
Override CSS sys_colour_InactiveCaptionText colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_InfoBackground
|
||||
.It Fl -sys_colour_InfoBackground
|
||||
Override CSS sys_colour_InfoBackground colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_InfoText
|
||||
.It Fl -sys_colour_InfoText
|
||||
Override CSS sys_colour_InfoText colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_Menu
|
||||
.It Fl -sys_colour_Menu
|
||||
Override CSS sys_colour_Menu colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_MenuText
|
||||
.It Fl -sys_colour_MenuText
|
||||
Override CSS sys_colour_MenuText colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_Scrollbar
|
||||
.It Fl -sys_colour_Scrollbar
|
||||
Override CSS sys_colour_Scrollbar colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ThreeDDarkShadow
|
||||
.It Fl -sys_colour_ThreeDDarkShadow
|
||||
Override CSS sys_colour_ThreeDDarkShadow colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ThreeDFace
|
||||
.It Fl -sys_colour_ThreeDFace
|
||||
Override CSS sys_colour_ThreeDFace colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ThreeDHighlight
|
||||
.It Fl -sys_colour_ThreeDHighlight
|
||||
Override CSS sys_colour_ThreeDHighlight colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ThreeDLightShadow
|
||||
.It Fl -sys_colour_ThreeDLightShadow
|
||||
Override CSS sys_colour_ThreeDLightShadow colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_ThreeDShadow
|
||||
.It Fl -sys_colour_ThreeDShadow
|
||||
Override CSS sys_colour_ThreeDShadow colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_Window
|
||||
.It Fl -sys_colour_Window
|
||||
Override CSS sys_colour_Window colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_WindowFrame
|
||||
.It Fl -sys_colour_WindowFrame
|
||||
Override CSS sys_colour_WindowFrame colour.
|
||||
.TP
|
||||
.B \-\-sys_colour_WindowText
|
||||
.It Fl -sys_colour_WindowText
|
||||
Override CSS sys_colour_WindowText colour.
|
||||
.TP
|
||||
.B \-\-render_resample
|
||||
.It Fl -render_resample
|
||||
render resample
|
||||
.TP
|
||||
.B \-\-downloads_clear
|
||||
.It Fl -downloads_clear
|
||||
downloads clear
|
||||
.TP
|
||||
.B \-\-request_overwrite
|
||||
.It Fl -request_overwrite
|
||||
request overwrite
|
||||
.TP
|
||||
.B \-\-downloads_directory
|
||||
.It Fl -downloads_directory
|
||||
downloads directory
|
||||
.TP
|
||||
.B \-\-url_file
|
||||
.It Fl -url_file
|
||||
url file
|
||||
.TP
|
||||
.B \-\-show_single_tab
|
||||
.It Fl -show_single_tab
|
||||
Force tabs to always be show.
|
||||
.TP
|
||||
.B \-\-button_type
|
||||
.It Fl -button_type
|
||||
button type
|
||||
.TP
|
||||
.B \-\-disable_popups
|
||||
.It Fl -disable_popups
|
||||
disable popups
|
||||
.TP
|
||||
.B \-\-disable_plugins
|
||||
.It Fl -disable_plugins
|
||||
disable plugins
|
||||
.TP
|
||||
.B \-\-history_age
|
||||
.It Fl -history_age
|
||||
history age
|
||||
.TP
|
||||
.B \-\-hover_urls
|
||||
.It Fl -hover_urls
|
||||
hover urls
|
||||
.TP
|
||||
.B \-\-focus_new
|
||||
.It Fl -focus_new
|
||||
focus new
|
||||
.TP
|
||||
.B \-\-new_blank
|
||||
.It Fl -new_blank
|
||||
new blank
|
||||
.TP
|
||||
.B \-\-hotlist_path
|
||||
.It Fl -hotlist_path
|
||||
hotlist path
|
||||
.TP
|
||||
.B \-\-source_tab
|
||||
.It Fl -source_tab
|
||||
source tab
|
||||
.TP
|
||||
.B \-\-current_theme
|
||||
.It Fl -current_theme
|
||||
current theme
|
||||
.SH SEE ALSO
|
||||
gtk-options(7)
|
||||
.SH AUTHOR
|
||||
netsurf was written by the netsurf developers.
|
||||
.PP
|
||||
This manual page was written by Vincent Sanders <vince@debian.org>,
|
||||
for the Debian project (and may be used by others).
|
||||
.Sh FILES
|
||||
.Bl -item -width HOMEconfignetsurfChoicesxxxx
|
||||
.It
|
||||
.Pa $HOME/.config/netsurf/Choices
|
||||
.It
|
||||
.Pa $HOME/.config/netsurf/Hotlist
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr gtk-options 7
|
||||
.Sh STANDARDS
|
||||
.Rs
|
||||
.%D December 3, 2014
|
||||
.%I Web Hypertext Application Technology Working Group
|
||||
.%T HTML Living Standard
|
||||
.%U https://html.spec.whatwg.org/multipage/
|
||||
.Re
|
||||
.Pp
|
||||
.Rs
|
||||
.%D June 7, 2011
|
||||
.%I World Wide Web Consortium
|
||||
.%T Cascading Style Sheets Level 2 Revision 1 (CSS 2.1) Specification
|
||||
.%U http://www.w3.org/TR/CSS21/
|
||||
.Re
|
||||
.Pp
|
||||
.Rs
|
||||
.%D December 17, 2014
|
||||
.%I Web Hypertext Application Technology Working Group
|
||||
.%T Document Object Model Living Standard
|
||||
.%U https://dom.spec.whatwg.org/
|
||||
.Re
|
||||
.Sh AUTHORS
|
||||
Authorship information for
|
||||
.Nm
|
||||
is available at the project homepage,
|
||||
.Lk http://www.netsurf-browser.org/
|
||||
.Pp
|
||||
This manual page was written by
|
||||
.An Vincent Sanders Aq Mt vince@netsurf-browser.org
|
||||
|
||||
Loading…
Reference in New Issue
Block a user