Adding kiosk mode.
[surf.git] / surf.1
diff --git a/surf.1 b/surf.1
index 9c2959b..339ff6b 100644 (file)
--- a/surf.1
+++ b/surf.1
 .TH SURF 1 surf\-VERSION
 .SH NAME
-surf \- simple webkit based browser
+surf \- simple webkit-based browser
 .SH SYNOPSIS
 .B surf
-.RB [ \-ehvx ]
-.RB [ \-f " FILE"]
-.RB [ \-u " URI"]
+.RB [-biknpsvx]
+.RB [-c\ cookiefile]
+.RB [-e\ xid]
+.RB [-r\ scriptfile]
+.RB [-t\ stylefile]
+.RB [-u\ useragent]
+.RB "URI"
 .SH DESCRIPTION
-surf is a simple webbrowser which is based on webkit/gtk+. It is able
-to display websites and follow links. It supports the Xembedded protocol
-which makes it possible to embed it into another application. Furthermore
-one can point surf to another URI by setting it's XProperties.
+surf is a simple Web browser based on WebKit/GTK+. It is able
+to display websites and follow links. It supports the XEmbed protocol
+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 \-e
-prints xid to standard output and waits until some application reparent the
-window.
+.B \-b
+Disable Scrollbars
 .TP
-.B \-f FILE
-Sets the browsers URI to FILE. Also it's possible to read from stdin.
+.B \-c cookiefile 
+Specify the
+.I cookiefile
+to use.
 .TP
-.B \-h
-prints usage information to standard output, then exits.
+.B \-e xid
+Reparents to window specified by
+.I xid.
 .TP
-.B \-u URI
-Sets the browsers URI.
+.B \-i
+Disable Images
+.TP
+.B \-k
+Enable kiosk mode (disable key strokes and right click)
+.TP
+.B \-n
+Disable the Web Inspector (Developer Tools).
+.TP
+.B \-p
+Disable Plugins
+.TP
+.B \-r scriptfile 
+Specify the user
+.I scriptfile.
+.TP
+.B \-s
+Disable Javascript
+.TP
+.B \-t stylefile
+Specify the user
+.I stylefile.
+.TP
+.B \-u useragent 
+Specify the
+.I useragent
+which surf should use.
 .TP
 .B \-v
-prints version information to standard output, then exits.
+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
-xprop
+Prints xid to standard output. This can be used to script the browser by using
+.BR xprop(1).
 .SH USAGE
+.B Escape
+Stops loading current page or stops download.
 .TP
-.B Ctrl\-Left
+.B Ctrl\-h
 Walks back the history.
 .TP
-.B Ctrl\-Right
+.B Ctrl\-l
 Walks forward the history.
 .TP
-.B Ctrl\-/
+.B Ctrl\-k
+Scrolls page upwards.
+.TP
+.B Ctrl\-j
+Scrolls page downwards.
+.TP
+.B Ctrl\-b
+Scroll up one whole page view.
+.TP
+.B Ctrl\-Space
+Scroll down one whole page view.
+.TP
+.B Ctrl\-i
+Scroll horizontally to the right.
+.TP
+.B Ctrl\-u
+Scroll horizontally to the left.
+.TP
+.B Ctrl\-Shift\-k or Ctrl\-+
+Zooms page in.
+.TP
+.B Ctrl\-Shift\-j or Ctrl\--
+Zooms page out
+.TP
+.B Ctrl\-Shift\-q
+Resets Zoom
+.TP
+.B Ctrl\-f and Ctrl\-\\
 Opens the search-bar.
 .TP
+.B Ctrl\-n
+Go to next search result.
+.TP
+.B Ctrl\-Shift\-n
+Go to previous search result.
+.TP
 .B Ctrl\-g
 Opens the URL-bar.
 .TP
+.B Ctrl\-p
+Loads URI from primary selection.
+.TP
+.B Esc
+Stop loading the page.
+.TP
+.B Ctrl\-Shift\-p
+Calls Printpage Dialog.
+.TP
 .B Ctrl\-r
 Reloads the website.
 .TP
 .B Ctrl\-Shift\-r
 Reloads the website without using cache.
+.TP
+.B Ctrl\-y
+Copies current URI to primary selection.
+.TP
+.B Ctrl\-o
+Show the sourcecode of the current page.
+.TP
+.B Ctrl\-Shift\-b
+Toggle scrollbars
+.TP
+.B Ctrl\-Shift\-c
+Toggle caret browsing.
+.TP
+.B Ctrl\-Shift\-i
+Toggle auto-loading of images.
+.TP
+.B Ctrl\-Shift\-m
+Toggle if the
+.I stylefile 
+file should be loaded.
+.TP
+.B Ctrl\-Shift\-o
+Open the Web Inspector (Developer Tools) window for the current page.
+.TP
+.B Ctrl\-Shift\-s
+Toggle script execution.
+.TP
+.B Ctrl\-Shift\-v
+Toggle the enabling of plugins on that surf instance.
+.TP
+.B F11
+Toggle fullscreen mode.
+.SH ENVIRONMENT
+.B SURF_USERAGENT
+If this variable is set upon startup, surf will use it as the
+.I useragent
+string
+.TP
+.B 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
+.BR /usr/lib/browser-plugins
+or
+.BR /usr/lib64/browser-plugins.
+Surf should load them automatically.
+.BR
+If you want to use a 32bit plugin on a 64bit system,
+.BR nspluginwrapper(1)
+will help you.
 .SH SEE ALSO
-.BR dmenu (1)
-.BR xprop (1)
+.BR dmenu(1),
+.BR xprop(1),
+.BR tabbed(1),
+.BR nspluginwrapper(1)
 .SH BUGS
 Please report them!