X-Git-Url: https://git.danieliu.xyz/?p=surf.git;a=blobdiff_plain;f=surf.1;h=711a9aaa4d113d3faf08df7afaa63ab3630e3208;hp=5b194ecf2ed51856ecab864cc0719c5d98cbe026;hb=5e2216c41434219e60ca52bc5f10d34fddbca964;hpb=780cca964ca0cf622746ad6e8cae8beb8047d1df diff --git a/surf.1 b/surf.1 index 5b194ec..711a9aa 100644 --- a/surf.1 +++ b/surf.1 @@ -3,15 +3,15 @@ surf \- simple webkit-based browser .SH SYNOPSIS .B surf -.RB [-bBfFgGiIkKnNpPsSvx] +.RB [-bBdDfFgGiIkKmMnNpPsStTvwxX] .RB [-a\ cookiepolicies] .RB [-c\ cookiefile] +.RB [-C\ stylefile] .RB [-e\ xid] .RB [-r\ scriptfile] -.RB [-t\ stylefile] .RB [-u\ useragent] .RB [-z\ zoomlevel] -.RB "URI" +.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 @@ -21,34 +21,45 @@ one can point surf to another URI by setting its XProperties. .TP .B \-a cookiepolicies Define the order of -.I cookie policies. -The default is "Aa@" but could be +.I cookie policies\fR. +The default is "@Aa" but could be redefined in the -.I config.h, +.IR config.h , with "A" meaning to accept all cookies, "a" to deny all cookies and "@", which tells surf to -accept all third party cookies. +accept no third party cookies. .TP .B \-b -Disable Scrollbars +Disable Scrollbars. .TP .B \-B -Enable Scrollbars +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 -Run surf in fullscreen mode. +Start surf in windowed mode (not fullscreen). .TP .B \-F -Disable to run in fullscreen by default. +Start surf in fullscreen mode. .TP .B \-g Disable giving the geolocation to websites. @@ -57,16 +68,22 @@ Disable giving the geolocation to websites. Enable giving the geolocation to websites. .TP .B \-i -Disable Images +Disable Images. .TP .B \-I -Enable Images +Enable Images. .TP .B \-k -Disable 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) +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). @@ -75,26 +92,28 @@ Disable the Web Inspector (Developer Tools). Enable the Web Inspector (Developer Tools). .TP .B \-p -Disable Plugins +Disable Plugins. .TP .B \-P -Enable Plugins +Enable Plugins. .TP -.B \-r scriptfile +.B \-r scriptfile Specify the user -.I scriptfile. +.IR scriptfile . .TP .B \-s -Disable Javascript +Disable Javascript. .TP .B \-S -Enable Javascript +Enable Javascript. .TP -.B \-t stylefile -Specify the user -.I stylefile. +.B \-t +Disable strict TLS check. +.TP +.B \-T +Enable strict TLS check. .TP -.B \-u useragent +.B \-u useragent Specify the .I useragent which surf should use. @@ -102,14 +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 +.B \-w +Prints xid to standard output. This can be used to script the browser in for +example +.BR xdotool(1) . .TP -.B \-z zoomlevel +.B -x +Disable custom certificates. +.TP +.B -X +Enable custom certificates. +.TP +.B \-z zoomlevel Specify the .I zoomlevel which surf should use. -.BR xprop(1). .SH USAGE .B Escape Stops loading current page or stops download. @@ -142,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 @@ -157,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. @@ -174,12 +200,12 @@ Reloads the website without using the cache. .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. +.I cookie policies\fR. This will not reload the page. .TP .B Ctrl\-Shift\-b @@ -193,7 +219,7 @@ Toggle auto-loading of images. This will reload the page. .TP .B Ctrl\-Shift\-m Toggle if the -.I stylefile +.I stylefile file should be loaded. This will reload the page. .TP .B Ctrl\-Shift\-o @@ -202,20 +228,84 @@ Open the Web Inspector (Developer Tools) window for the current page. .B Ctrl\-Shift\-s 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. 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 PLUGINS For using plugins in surf, first determine your running architecture. Then get the appropriate plugin for that architecture and copy it to @@ -231,6 +321,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!