Add the manpage changes for the disk cache support.

[surf.git] / surf.1

diff --git a/surf.1 b/surf.1
index 9938e98..db25023 100644 (file)
--- a/surf.1
+++ b/surf.1
@@ -3,12 +3,14 @@
 surf \- simple webkit-based browser
 .SH SYNOPSIS
 .B surf
 surf \- simple webkit-based browser
 .SH SYNOPSIS
 .B surf

-.RB [-bgiknpsvx]
+.RB [-bBdDfFgGiIkKmMnNpPsSvx]
+.RB [-a\ cookiepolicies]

 .RB [-c\ cookiefile]
 .RB [-e\ xid]
 .RB [-r\ scriptfile]
 .RB [-t\ stylefile]
 .RB [-u\ useragent]
 .RB [-c\ cookiefile]
 .RB [-e\ xid]
 .RB [-r\ scriptfile]
 .RB [-t\ stylefile]
 .RB [-u\ useragent]

+.RB [-z\ zoomlevel]

 .RB "URI"
 .SH DESCRIPTION
 surf is a simple Web browser based on WebKit/GTK+. It is able
 .RB "URI"
 .SH DESCRIPTION
 surf is a simple Web browser based on WebKit/GTK+. It is able


@@ -17,33 +19,79 @@ 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
 one can point surf to another URI by setting its XProperties.
 .SH OPTIONS
 .TP

+.B \-a cookiepolicies
+Define the order of
+.I cookie policies.
+The default is "Aa@" but could be
+redefined in the
+.I 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
 .TP
 .B \-b
 Disable Scrollbars
 .TP

+.B \-B
+Enable Scrollbars
+.TP

 .B \-c cookiefile 
 Specify the
 .I cookiefile
 to use.
 .TP
 .B \-c cookiefile 
 Specify the
 .I cookiefile
 to use.
 .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.
 .TP
 .B \-e xid
 Reparents to window specified by
 .I xid.
 .TP

+.B \-f
+Run surf in fullscreen mode.
+.TP
+.B \-F
+Disable to run in fullscreen by default.
+.TP

 .B \-g
 Disable giving the geolocation to websites.
 .TP
 .B \-g
 Disable giving the geolocation to websites.
 .TP

+.B \-G
+Enable giving the geolocation to websites.
+.TP

 .B \-i
 Disable Images
 .TP
 .B \-i
 Disable Images
 .TP

+.B \-I
+Enable Images
+.TP

 .B \-k
 .B \-k

+Disable kiosk mode (disable key strokes and right click)
+.TP
+.B \-K

 Enable kiosk mode (disable key strokes and right click)
 .TP
 Enable kiosk mode (disable key strokes and right click)
 .TP

+.B \-m
+Disable the site-specific styles.
+.TP
+.B \-M
+Enable the site-specific styles.
+.TP

 .B \-n
 Disable the Web Inspector (Developer Tools).
 .TP
 .B \-n
 Disable the Web Inspector (Developer Tools).
 .TP

+.B \-N
+Enable the Web Inspector (Developer Tools).
+.TP

 .B \-p
 Disable Plugins
 .TP
 .B \-p
 Disable Plugins
 .TP

+.B \-P
+Enable Plugins
+.TP

 .B \-r scriptfile 
 Specify the user
 .I scriptfile.
 .B \-r scriptfile 
 Specify the user
 .I scriptfile.


@@ -51,9 +99,13 @@ Specify the user
 .B \-s
 Disable Javascript
 .TP
 .B \-s
 Disable Javascript
 .TP

+.B \-S
+Enable Javascript
+.TP

 .B \-t stylefile
 Specify the user
 .I stylefile.
 .B \-t stylefile
 Specify the user
 .I stylefile.

+This does disable the site-specific styles.

 .TP
 .B \-u useragent 
 Specify the
 .TP
 .B \-u useragent 
 Specify the


@@ -64,7 +116,14 @@ which surf should use.
 Prints version information to standard output, then exits.
 .TP
 .B \-x
 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
+Prints xid to standard output. This can be used to script the browser in for
+example
+.BR xdotool(1).
+.TP
+.B \-z zoomlevel 
+Specify the
+.I zoomlevel
+which surf should use.

 .BR xprop(1).
 .SH USAGE
 .B Escape
 .BR xprop(1).
 .SH USAGE
 .B Escape


@@ -103,7 +162,7 @@ Zooms page out
 .B Ctrl\-Shift\-q
 Resets Zoom
 .TP
 .B Ctrl\-Shift\-q
 Resets Zoom
 .TP

-.B Ctrl\-f and Ctrl\-\e
+.B Ctrl\-f and Ctrl\-/

 Opens the search-bar.
 .TP
 .B Ctrl\-n
 Opens the search-bar.
 .TP
 .B Ctrl\-n


@@ -113,14 +172,11 @@ Go to next search result.
 Go to previous search result.
 .TP
 .B Ctrl\-g
 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.
 .TP
 .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\-Shift\-p
 Calls Printpage Dialog.
 .TP


@@ -128,7 +184,7 @@ Calls Printpage Dialog.
 Reloads the website.
 .TP
 .B Ctrl\-Shift\-r
 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\-y
 Copies current URI to primary selection.


@@ -136,28 +192,34 @@ Copies current URI to primary selection.
 .B Ctrl\-o
 Show the sourcecode of the current page.
 .TP
 .B Ctrl\-o
 Show the sourcecode of the current page.
 .TP

+.B Ctrl\-Shift\-a
+Toggle through the the
+.I cookie policies.
+This will not reload the page.
+.TP

 .B Ctrl\-Shift\-b
 .B Ctrl\-Shift\-b

-Toggle scrollbars
+Toggle scrollbars. This will reload the page.

 .TP
 .B Ctrl\-Shift\-c
 .TP
 .B Ctrl\-Shift\-c

-Toggle caret browsing.
+Toggle caret browsing. This will reload the page.

 .TP
 .B Ctrl\-Shift\-i
 .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 
 .TP
 .B Ctrl\-Shift\-m
 Toggle if the
 .I stylefile 

-file should be loaded.
+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
 .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\-v
 .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.
 .TP
 .B F11
 Toggle fullscreen mode.


@@ -184,6 +246,7 @@ will help you.
 .BR dmenu(1),
 .BR xprop(1),
 .BR tabbed(1),
 .BR dmenu(1),
 .BR xprop(1),
 .BR tabbed(1),

-.BR nspluginwrapper(1)
+.BR nspluginwrapper(1),
+.BR xdotool(1)

 .SH BUGS
 Please report them!
 .SH BUGS
 Please report them!