surf

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

surf.1 (5353B)


      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 \-r scriptfile
     95 Specify the user
     96 .IR scriptfile .
     97 .TP
     98 .B \-s
     99 Disable Javascript.
    100 .TP
    101 .B \-S
    102 Enable Javascript.
    103 .TP
    104 .B \-t
    105 Disable strict TLS check.
    106 .TP
    107 .B \-T
    108 Enable strict TLS check.
    109 .TP
    110 .B \-u useragent
    111 Specify the
    112 .I useragent
    113 which surf should use.
    114 .TP
    115 .B \-v
    116 Prints version information to standard output, then exits.
    117 .TP
    118 .B \-w
    119 Prints xid to standard output. This can be used to script the browser in for
    120 example
    121 .BR xdotool(1) .
    122 .TP
    123 .B -x
    124 Disable custom certificates.
    125 .TP
    126 .B -X
    127 Enable custom certificates.
    128 .TP
    129 .B \-z zoomlevel
    130 Specify the
    131 .I zoomlevel
    132 which surf should use.
    133 .SH USAGE
    134 .B Escape
    135 Stops loading current page or stops download.
    136 .TP
    137 .B Ctrl\-h
    138 Walks back the history.
    139 .TP
    140 .B Ctrl\-l
    141 Walks forward the history.
    142 .TP
    143 .B Ctrl\-k
    144 Scrolls page upwards.
    145 .TP
    146 .B Ctrl\-j
    147 Scrolls page downwards.
    148 .TP
    149 .B Ctrl\-b
    150 Scroll up one whole page view.
    151 .TP
    152 .B Ctrl\-Space
    153 Scroll down one whole page view.
    154 .TP
    155 .B Ctrl\-i
    156 Scroll horizontally to the right.
    157 .TP
    158 .B Ctrl\-u
    159 Scroll horizontally to the left.
    160 .TP
    161 .B Ctrl\-Shift\-k or Ctrl\-+
    162 Zooms page in.
    163 .TP
    164 .B Ctrl\-Shift\-j or Ctrl\--
    165 Zooms page out.
    166 .TP
    167 .B Ctrl\-Shift\-q
    168 Resets Zoom.
    169 .TP
    170 .B Ctrl\-f and Ctrl\-/
    171 Opens the search-bar.
    172 .TP
    173 .B Ctrl\-n
    174 Go to next search result.
    175 .TP
    176 .B Ctrl\-Shift\-n
    177 Go to previous search result.
    178 .TP
    179 .B Ctrl\-g
    180 Opens the URL-bar (requires dmenu installed).
    181 .TP
    182 .B Ctrl\-p
    183 Loads URI from primary selection.
    184 .TP
    185 .B Ctrl\-Shift\-p
    186 Calls Printpage Dialog.
    187 .TP
    188 .B Ctrl\-r
    189 Reloads the website.
    190 .TP
    191 .B Ctrl\-Shift\-r
    192 Reloads the website without using the cache.
    193 .TP
    194 .B Ctrl\-y
    195 Copies current URI to primary selection.
    196 .TP
    197 .B Ctrl\-t
    198 Display the current TLS certificate in a popup window.
    199 .TP
    200 .B Ctrl\-Shift\-a
    201 Toggle through the the
    202 .I cookie policies\fR.
    203 This will not reload the page.
    204 .TP
    205 .B Ctrl\-Shift\-b
    206 Toggle scrollbars. This will reload the page.
    207 .TP
    208 .B Ctrl\-Shift\-c
    209 Toggle caret browsing. This will reload the page.
    210 .TP
    211 .B Ctrl\-Shift\-i
    212 Toggle auto-loading of images. This will reload the page.
    213 .TP
    214 .B Ctrl\-Shift\-m
    215 Toggle if the
    216 .I stylefile
    217 file should be loaded. This will reload the page.
    218 .TP
    219 .B Ctrl\-Shift\-o
    220 Open the Web Inspector (Developer Tools) window for the current page.
    221 .TP
    222 .B Ctrl\-Shift\-s
    223 Toggle script execution. This will reload the page.
    224 .TP
    225 .B Ctrl\-Shift\-t
    226 Toggle strict TLS check. This will reload the page.
    227 .TP
    228 .B F11
    229 Toggle fullscreen mode.
    230 .SH INDICATORS OF OPERATION
    231 Surf is showing indicators of operation in front of the site title.
    232 For all indicators, unless otherwise specified, a lower case letter means disabled and an upper case letter means enabled.
    233 .TP
    234 .B A
    235 all cookies accepted
    236 .TP
    237 .B a
    238 no cookies accepted
    239 .TP
    240 .B @
    241 all except third-party cookies accepted
    242 .TP
    243 .B c C
    244 caret browsing
    245 .TP
    246 .B g G
    247 geolocation
    248 .TP
    249 .B d D
    250 disk cache
    251 .TP
    252 .B i I
    253 images
    254 .TP
    255 .B s S
    256 scripts
    257 .TP
    258 .B m M
    259 styles
    260 .TP
    261 .B f F
    262 frame flattening
    263 .TP
    264 .B x X
    265 custom certificates
    266 .TP
    267 .B t T
    268 strict TLS
    269 .SH INDICATORS OF WEB PAGE
    270 The second part of the indicators specifies modes of the web page itself.
    271 .SS First character: encryption
    272 .TP
    273 .B -
    274 unencrypted
    275 .TP
    276 .B T
    277 encrypted (TLS)
    278 .TP
    279 .B U
    280 attempted encryption but failed
    281 .SS Second character: proxying
    282 .TP
    283 .B -
    284 no proxy
    285 .TP
    286 .B P
    287 using proxy
    288 .SH ENVIRONMENT
    289 .B SURF_USERAGENT
    290 If this variable is set upon startup, surf will use it as the
    291 .I useragent
    292 string.
    293 .TP
    294 .B http_proxy
    295 If this variable is set and not empty upon startup, surf will use it as the http proxy.
    296 .SH SIGNALS
    297 Surf will reload the current page on
    298 .BR SIGHUP .
    299 .SH SEE ALSO
    300 .BR dmenu(1),
    301 .BR xprop(1),
    302 .BR tabbed(1),
    303 .BR xdotool(1)
    304 .SH BUGS
    305 Please report them!