X-Git-Url: https://git.danieliu.xyz/?p=surf.git;a=blobdiff_plain;f=surf.1;h=45c31bb17db5ef7c2a29b80b4e8631ee2715c04a;hp=5a0ff3fd526bef850cffc4fe9d3cfd7f9b878b34;hb=47e39851ca12749d24c66f948054c42289756ca7;hpb=4f45ae9307050397dbeb18ea00121aa82c867685 diff --git a/surf.1 b/surf.1 index 5a0ff3f..45c31bb 100644 --- a/surf.1 +++ b/surf.1 @@ -3,13 +3,15 @@ surf \- simple webkit-based browser .SH SYNOPSIS .B surf -.RB [-bgiknpsvx] +.RB [-bBdDfFgGiIkKmMnNpPsStTvwxX] +.RB [-a\ cookiepolicies] .RB [-c\ cookiefile] +.RB [-C\ stylefile] .RB [-e\ xid] .RB [-r\ scriptfile] -.RB [-t\ stylefile] .RB [-u\ useragent] -.RB "URI" +.RB [-z\ zoomlevel] +.RB [URI] .SH DESCRIPTION surf is a simple Web browser based on WebKit/GTK+. It is able to display websites and follow links. It supports the XEmbed protocol @@ -17,45 +19,101 @@ which makes it possible to embed it in another application. Furthermore, one can point surf to another URI by setting its XProperties. .SH OPTIONS .TP +.B \-a cookiepolicies +Define the order of +.I cookie policies\fR. +The default is "@Aa" but could be +redefined in the +.IR config.h , +with "A" meaning to +accept all cookies, "a" to deny all cookies and "@", which tells surf to +accept no third party cookies. +.TP .B \-b -Disable Scrollbars +Disable Scrollbars. +.TP +.B \-B +Enable Scrollbars. .TP -.B \-c cookiefile +.B \-c cookiefile Specify the .I cookiefile to use. .TP +.B \-C stylefile +Specify the user +.IR stylefile . +This does disable the site-specific styles. +.TP +.B \-d +Disable the disk cache. +.TP +.B \-D +Enable the disk cache. +.TP .B \-e xid Reparents to window specified by -.I xid. +.IR xid . +.TP +.B \-f +Start surf in windowed mode (not fullscreen). +.TP +.B \-F +Start surf in fullscreen mode. .TP .B \-g Disable giving the geolocation to websites. .TP +.B \-G +Enable giving the geolocation to websites. +.TP .B \-i -Disable Images +Disable Images. +.TP +.B \-I +Enable Images. .TP .B \-k -Enable kiosk mode (disable key strokes and right click) +Disable kiosk mode (disable key strokes and right click). +.TP +.B \-K +Enable kiosk mode (disable key strokes and right click). +.TP +.B \-m +Disable application of user style sheets. +.TP +.B \-M +Enable application of user style sheets. .TP .B \-n Disable the Web Inspector (Developer Tools). .TP +.B \-N +Enable the Web Inspector (Developer Tools). +.TP .B \-p -Disable Plugins +Disable Plugins. .TP -.B \-r scriptfile +.B \-P +Enable Plugins. +.TP +.B \-r scriptfile Specify the user -.I scriptfile. +.IR scriptfile . .TP .B \-s -Disable Javascript +Disable Javascript. .TP -.B \-t stylefile -Specify the user -.I stylefile. +.B \-S +Enable Javascript. +.TP +.B \-t +Disable strict TLS check. .TP -.B \-u useragent +.B \-T +Enable strict TLS check. +.TP +.B \-u useragent Specify the .I useragent which surf should use. @@ -63,9 +121,21 @@ which surf should use. .B \-v Prints version information to standard output, then exits. .TP -.B \-x -Prints xid to standard output. This can be used to script the browser by using -.BR xprop(1). +.B \-w +Prints xid to standard output. This can be used to script the browser in for +example +.BR xdotool(1) . +.TP +.B -x +Disable custom certificates. +.TP +.B -X +Enable custom certificates. +.TP +.B \-z zoomlevel +Specify the +.I zoomlevel +which surf should use. .SH USAGE .B Escape Stops loading current page or stops download. @@ -98,12 +168,12 @@ Scroll horizontally to the left. Zooms page in. .TP .B Ctrl\-Shift\-j or Ctrl\-- -Zooms page out +Zooms page out. .TP .B Ctrl\-Shift\-q -Resets Zoom +Resets Zoom. .TP -.B Ctrl\-f and Ctrl\-\e +.B Ctrl\-f and Ctrl\-/ Opens the search-bar. .TP .B Ctrl\-n @@ -113,7 +183,7 @@ Go to next search result. Go to previous search result. .TP .B Ctrl\-g -Opens the URL-bar. +Opens the URL-bar (requires dmenu installed). .TP .B Ctrl\-p Loads URI from primary selection. @@ -125,47 +195,120 @@ Calls Printpage Dialog. Reloads the website. .TP .B Ctrl\-Shift\-r -Reloads the website without using cache. +Reloads the website without using the cache. .TP .B Ctrl\-y Copies current URI to primary selection. .TP -.B Ctrl\-o -Show the sourcecode of the current page. +.B Ctrl\-t +Display the current TLS certificate in a popup window. +.TP +.B Ctrl\-Shift\-a +Toggle through the the +.I cookie policies\fR. +This will not reload the page. .TP .B Ctrl\-Shift\-b -Toggle scrollbars +Toggle scrollbars. This will reload the page. .TP .B Ctrl\-Shift\-c -Toggle caret browsing. +Toggle caret browsing. This will reload the page. .TP .B Ctrl\-Shift\-i -Toggle auto-loading of images. +Toggle auto-loading of images. This will reload the page. .TP .B Ctrl\-Shift\-m Toggle if the -.I stylefile -file should be loaded. +.I stylefile +file should be loaded. This will reload the page. .TP .B Ctrl\-Shift\-o Open the Web Inspector (Developer Tools) window for the current page. .TP .B Ctrl\-Shift\-s -Toggle script execution. +Toggle script execution. This will reload the page. +.TP +.B Ctrl\-Shift\-t +Toggle strict TLS check. This will reload the page. .TP .B Ctrl\-Shift\-v -Toggle the enabling of plugins on that surf instance. +Toggle the enabling of plugins on that surf instance. This will reload the +page. .TP .B F11 Toggle fullscreen mode. +.SH INDICATORS OF OPERATION +Surf is showing indicators of operation in front of the site title. +For all indicators, unless otherwise specified, a lower case letter means disabled and an upper case letter means enabled. +.TP +.B A +all cookies accepted +.TP +.B a +no cookies accepted +.TP +.B @ +all except third-party cookies accepted +.TP +.B c C +caret browsing +.TP +.B g G +geolocation +.TP +.B d D +disk cache +.TP +.B i I +images +.TP +.B s S +scripts +.TP +.B v V +plugins +.TP +.B m M +styles +.TP +.B f F +frame flattening +.TP +.B x X +custom certificates +.TP +.B t T +strict TLS +.SH INDICATORS OF WEB PAGE +The second part of the indicators specifies modes of the web page itself. +.SS First character: encryption +.TP +.B - +unencrypted +.TP +.B T +encrypted (TLS) +.TP +.B U +attempted encryption but failed +.SS Second character: proxying +.TP +.B - +no proxy +.TP +.B P +using proxy .SH ENVIRONMENT .B SURF_USERAGENT If this variable is set upon startup, surf will use it as the .I useragent -string +string. .TP .B http_proxy -If this variable is set and not empty upon startup, surf will use it as the http proxy +If this variable is set and not empty upon startup, surf will use it as the http proxy. +.SH SIGNALS +Surf will reload the current page on +.BR SIGHUP . .SH PLUGINS For using plugins in surf, first determine your running architecture. Then get the appropriate plugin for that architecture and copy it to @@ -181,6 +324,7 @@ will help you. .BR dmenu(1), .BR xprop(1), .BR tabbed(1), -.BR nspluginwrapper(1) +.BR nspluginwrapper(1), +.BR xdotool(1) .SH BUGS Please report them!