surf

surf browser, a WebKit based browser
git clone git://git.suckless.org/surf
Log | Files | Refs | README | LICENSE

surf.1 (5901B)


      1 .TH SURF 1 surf\-VERSION
      2 .SH NAME
      3 surf \- simple webkit-based browser
      4 .SH SYNOPSIS
      5 .B surf
      6 .RB [-bBdDfFgGiIkKmMnNpPsStTvwxX]
      7 .RB [-a\ cookiepolicies]
      8 .RB [-c\ cookiefile]
      9 .RB [-C\ stylefile]
     10 .RB [-e\ xid]
     11 .RB [-r\ scriptfile]
     12 .RB [-u\ useragent]
     13 .RB [-z\ zoomlevel]
     14 .RB [URI]
     15 .SH DESCRIPTION
     16 surf is a simple Web browser based on WebKit/GTK+. It is able
     17 to display websites and follow links. It supports the XEmbed protocol
     18 which makes it possible to embed it in another application. Furthermore,
     19 one can point surf to another URI by setting its XProperties.
     20 .SH OPTIONS
     21 .TP
     22 .B \-a cookiepolicies
     23 Define the order of
     24 .I cookie policies\fR.
     25 The default is "@Aa" but could be
     26 redefined in the
     27 .IR config.h ,
     28 with "A" meaning to
     29 accept all cookies, "a" to deny all cookies and "@", which tells surf to
     30 accept no third party cookies.
     31 .TP
     32 .B \-b
     33 Disable Scrollbars.
     34 .TP
     35 .B \-B
     36 Enable Scrollbars.
     37 .TP
     38 .B \-c cookiefile
     39 Specify the
     40 .I cookiefile
     41 to use.
     42 .TP
     43 .B \-C stylefile
     44 Specify the user
     45 .IR stylefile .
     46 This does disable the site-specific styles.
     47 .TP
     48 .B \-d
     49 Disable the disk cache.
     50 .TP
     51 .B \-D
     52 Enable the disk cache.
     53 .TP
     54 .B \-e xid
     55 Reparents to window specified by
     56 .IR xid .
     57 .TP
     58 .B \-f
     59 Start surf in windowed mode (not fullscreen).
     60 .TP
     61 .B \-F
     62 Start surf in fullscreen mode.
     63 .TP
     64 .B \-g
     65 Disable giving the geolocation to websites.
     66 .TP
     67 .B \-G
     68 Enable giving the geolocation to websites.
     69 .TP
     70 .B \-i
     71 Disable Images.
     72 .TP
     73 .B \-I
     74 Enable Images.
     75 .TP
     76 .B \-k
     77 Disable kiosk mode (disable key strokes and right click).
     78 .TP
     79 .B \-K
     80 Enable kiosk mode (disable key strokes and right click).
     81 .TP
     82 .B \-m
     83 Disable application of user style sheets.
     84 .TP
     85 .B \-M
     86 Enable application of user style sheets.
     87 .TP
     88 .B \-n
     89 Disable the Web Inspector (Developer Tools).
     90 .TP
     91 .B \-N
     92 Enable the Web Inspector (Developer Tools).
     93 .TP
     94 .B \-p
     95 Disable Plugins.
     96 .TP
     97 .B \-P
     98 Enable Plugins.
     99 .TP
    100 .B \-r scriptfile
    101 Specify the user
    102 .IR scriptfile .
    103 .TP
    104 .B \-s
    105 Disable Javascript.
    106 .TP
    107 .B \-S
    108 Enable Javascript.
    109 .TP
    110 .B \-t
    111 Disable strict TLS check.
    112 .TP
    113 .B \-T
    114 Enable strict TLS check.
    115 .TP
    116 .B \-u useragent
    117 Specify the
    118 .I useragent
    119 which surf should use.
    120 .TP
    121 .B \-v
    122 Prints version information to standard output, then exits.
    123 .TP
    124 .B \-w
    125 Prints xid to standard output. This can be used to script the browser in for
    126 example
    127 .BR xdotool(1) .
    128 .TP
    129 .B -x
    130 Disable custom certificates.
    131 .TP
    132 .B -X
    133 Enable custom certificates.
    134 .TP
    135 .B \-z zoomlevel
    136 Specify the
    137 .I zoomlevel
    138 which surf should use.
    139 .SH USAGE
    140 .B Escape
    141 Stops loading current page or stops download.
    142 .TP
    143 .B Ctrl\-h
    144 Walks back the history.
    145 .TP
    146 .B Ctrl\-l
    147 Walks forward the history.
    148 .TP
    149 .B Ctrl\-k
    150 Scrolls page upwards.
    151 .TP
    152 .B Ctrl\-j
    153 Scrolls page downwards.
    154 .TP
    155 .B Ctrl\-b
    156 Scroll up one whole page view.
    157 .TP
    158 .B Ctrl\-Space
    159 Scroll down one whole page view.
    160 .TP
    161 .B Ctrl\-i
    162 Scroll horizontally to the right.
    163 .TP
    164 .B Ctrl\-u
    165 Scroll horizontally to the left.
    166 .TP
    167 .B Ctrl\-Shift\-k or Ctrl\-+
    168 Zooms page in.
    169 .TP
    170 .B Ctrl\-Shift\-j or Ctrl\--
    171 Zooms page out.
    172 .TP
    173 .B Ctrl\-Shift\-q
    174 Resets Zoom.
    175 .TP
    176 .B Ctrl\-f and Ctrl\-/
    177 Opens the search-bar.
    178 .TP
    179 .B Ctrl\-n
    180 Go to next search result.
    181 .TP
    182 .B Ctrl\-Shift\-n
    183 Go to previous search result.
    184 .TP
    185 .B Ctrl\-g
    186 Opens the URL-bar (requires dmenu installed).
    187 .TP
    188 .B Ctrl\-p
    189 Loads URI from primary selection.
    190 .TP
    191 .B Ctrl\-Shift\-p
    192 Calls Printpage Dialog.
    193 .TP
    194 .B Ctrl\-r
    195 Reloads the website.
    196 .TP
    197 .B Ctrl\-Shift\-r
    198 Reloads the website without using the cache.
    199 .TP
    200 .B Ctrl\-y
    201 Copies current URI to primary selection.
    202 .TP
    203 .B Ctrl\-t
    204 Display the current TLS certificate in a popup window.
    205 .TP
    206 .B Ctrl\-Shift\-a
    207 Toggle through the the
    208 .I cookie policies\fR.
    209 This will not reload the page.
    210 .TP
    211 .B Ctrl\-Shift\-b
    212 Toggle scrollbars. This will reload the page.
    213 .TP
    214 .B Ctrl\-Shift\-c
    215 Toggle caret browsing. This will reload the page.
    216 .TP
    217 .B Ctrl\-Shift\-i
    218 Toggle auto-loading of images. This will reload the page.
    219 .TP
    220 .B Ctrl\-Shift\-m
    221 Toggle if the
    222 .I stylefile
    223 file should be loaded. This will reload the page.
    224 .TP
    225 .B Ctrl\-Shift\-o
    226 Open the Web Inspector (Developer Tools) window for the current page.
    227 .TP
    228 .B Ctrl\-Shift\-s
    229 Toggle script execution. This will reload the page.
    230 .TP
    231 .B Ctrl\-Shift\-t
    232 Toggle strict TLS check. This will reload the page.
    233 .TP
    234 .B Ctrl\-Shift\-v
    235 Toggle the enabling of plugins on that surf instance. This will reload the
    236 page.
    237 .TP
    238 .B F11
    239 Toggle fullscreen mode.
    240 .SH INDICATORS OF OPERATION
    241 Surf is showing indicators of operation in front of the site title.
    242 For all indicators, unless otherwise specified, a lower case letter means disabled and an upper case letter means enabled.
    243 .TP
    244 .B A
    245 all cookies accepted
    246 .TP
    247 .B a
    248 no cookies accepted
    249 .TP
    250 .B @
    251 all except third-party cookies accepted
    252 .TP
    253 .B c C
    254 caret browsing
    255 .TP
    256 .B g G
    257 geolocation
    258 .TP
    259 .B d D
    260 disk cache
    261 .TP
    262 .B i I
    263 images
    264 .TP
    265 .B s S
    266 scripts
    267 .TP
    268 .B v V
    269 plugins
    270 .TP
    271 .B m M
    272 styles
    273 .TP
    274 .B f F
    275 frame flattening
    276 .TP
    277 .B x X
    278 custom certificates
    279 .TP
    280 .B t T
    281 strict TLS
    282 .SH INDICATORS OF WEB PAGE
    283 The second part of the indicators specifies modes of the web page itself.
    284 .SS First character: encryption
    285 .TP
    286 .B -
    287 unencrypted
    288 .TP
    289 .B T
    290 encrypted (TLS)
    291 .TP
    292 .B U
    293 attempted encryption but failed
    294 .SS Second character: proxying
    295 .TP
    296 .B -
    297 no proxy
    298 .TP
    299 .B P
    300 using proxy
    301 .SH ENVIRONMENT
    302 .B SURF_USERAGENT
    303 If this variable is set upon startup, surf will use it as the
    304 .I useragent
    305 string.
    306 .TP
    307 .B http_proxy
    308 If this variable is set and not empty upon startup, surf will use it as the http proxy.
    309 .SH SIGNALS
    310 Surf will reload the current page on
    311 .BR SIGHUP .
    312 .SH PLUGINS
    313 For using plugins in surf, first determine your running architecture. Then get
    314 the appropriate plugin for that architecture and copy it to
    315 .BR /usr/lib/browser-plugins
    316 or
    317 .BR /usr/lib64/browser-plugins.
    318 Surf should load them automatically.
    319 .BR
    320 If you want to use a 32bit plugin on a 64bit system,
    321 .BR nspluginwrapper(1)
    322 will help you.
    323 .SH SEE ALSO
    324 .BR dmenu(1),
    325 .BR xprop(1),
    326 .BR tabbed(1),
    327 .BR nspluginwrapper(1),
    328 .BR xdotool(1)
    329 .SH BUGS
    330 Please report them!