rev |
line source |
pankso@3
|
1 <!DOCTYPE html>
|
al@188
|
2 <html lang="en">
|
pankso@3
|
3 <head>
|
al@188
|
4 <meta charset="UTF-8">
|
pankso@3
|
5 <title>TazWeb Documentation</title>
|
al@188
|
6 <link rel="stylesheet" href="style.css">
|
pankso@3
|
7 </head>
|
pankso@3
|
8 <body>
|
al@188
|
9
|
al@188
|
10 <header>
|
pankso@197
|
11 <h1>Documentation</h1>
|
al@188
|
12 </header>
|
pankso@3
|
13
|
al@188
|
14 <main>
|
pankso@3
|
15
|
pankso@195
|
16 <h2>TazWeb Browser</h2>
|
pankso@3
|
17
|
pankso@195
|
18 <p>TazWeb is a modern, radically simple and very light web browser providing all
|
pankso@195
|
19 needed functions for daily browsing on the internet. TazWeb is aware of users
|
paul@196
|
20 privacy, it handles cookies but will NOT store any passwords or other user info.</p>
|
al@188
|
21
|
pankso@195
|
22 <p>TazWeb provides a single window with a small toolbar and a contextual
|
pankso@195
|
23 menu, but without any menubar or tabs. Navigation is done with a right click
|
pankso@195
|
24 anywhere in the browser window or from the toolbar. TazWeb lets you quickly
|
paul@196
|
25 search the web through a search entry redirecting to a DuckDuck Go secure search
|
pankso@195
|
26 engine. This documentation file is always accessible from the right-click
|
pankso@195
|
27 menu.</p>
|
al@188
|
28
|
pankso@195
|
29 <p>The browser's fast, very fast and small, the binary is about 30 Kb and
|
pankso@195
|
30 uses the WebkitGTK engine for page rendering and therefore supports all the
|
pankso@195
|
31 latest web standards as well as Javascript and Flash animations or videos.</p>
|
pankso@195
|
32
|
pankso@195
|
33 <h3>Major features</h3>
|
pankso@195
|
34
|
pankso@195
|
35 <ul>
|
pankso@195
|
36 <li>Cookie support</li>
|
pankso@195
|
37 <li>Download support</li>
|
pankso@195
|
38 <li>Text based config file</li>
|
pankso@195
|
39 <li>Search engine entry box</li>
|
pankso@195
|
40 <li>Bookmarks manager</li>
|
pankso@195
|
41 <li>Print, including to pdf</li>
|
pankso@195
|
42 <li>Rich contextual menu</li>
|
pankso@195
|
43 <li>Private browsing</li>
|
pankso@195
|
44 </ul>
|
pankso@93
|
45
|
pankso@93
|
46 <h3>History</h3>
|
al@188
|
47
|
pankso@195
|
48 <p>The SliTaz Web Browser was created for the needs of TazPanel which is
|
pankso@195
|
49 the SliTaz administration and packages manager panel and made with the
|
pankso@195
|
50 latest technologies such as HTML 5 and CSS 3 for the graphical user interface.
|
pankso@195
|
51 The content is powered by CGI scripts and the preferred web server is
|
pankso@195
|
52 Busybox httpd.</p>
|
al@188
|
53
|
pankso@93
|
54
|
pankso@195
|
55 <h3>Security and private browsing</h3>
|
al@188
|
56
|
pankso@195
|
57 <p>TazWeb is a very secure browser and doesn't store any personal data,
|
paul@196
|
58 therefore no sessions, passwords or history files are created, but it will
|
pankso@195
|
59 handle cookies by default.
|
pankso@195
|
60 So your websites cookies will save your peer site settings but logins
|
paul@196
|
61 and passwords will not be saved and you will have to re-enter login information
|
pankso@195
|
62 each time you restart the browser (by the way websites can track you
|
pankso@195
|
63 with cookies!).</p>
|
pankso@195
|
64
|
paul@196
|
65 <p>TazWeb provide a private browsing mode which will disable cookies, on-disk
|
paul@196
|
66 sessions and global histories. You can use the command line option to start
|
pankso@195
|
67 TazWeb in private mode:</p>
|
pankso@195
|
68
|
pankso@195
|
69 <pre>$ tazweb --private</pre>
|
al@188
|
70
|
pankso@3
|
71
|
pankso@130
|
72 <h3>Kiosk mode</h3>
|
al@188
|
73
|
al@188
|
74 <p>TazWeb provides a Kiosk mode useful for computers in public areas.
|
al@188
|
75 The Kiosk mode will start TazWeb in fullscreen.
|
al@188
|
76 It will not allow users to bookmark a page, download anything or open a URL in a new window.</p>
|
al@188
|
77
|
pankso@195
|
78 <pre>$ tazweb --kiosk</pre>
|
pankso@130
|
79
|
al@188
|
80
|
pankso@195
|
81 <h3>Raw and minimal mode</h3>
|
pankso@195
|
82
|
paul@196
|
83 <p>TazWeb has a very modular interface and everything can be disabled
|
paul@196
|
84 to provide a raw webkit window with no toolbar or menu. It also provides
|
pankso@195
|
85 a command line option to have a small (640x480) window suitable for tiny
|
pankso@195
|
86 web applications. The option --notoolbar and --nomenu can be used to
|
paul@196
|
87 hide the toolbar and menu; the --raw option will disable both:</p>
|
pankso@195
|
88
|
pankso@195
|
89 <pre>$ tazweb --raw</pre>
|
pankso@195
|
90
|
pankso@141
|
91 <h3>Home Page and bookmarks</h3>
|
al@188
|
92
|
pankso@195
|
93 <p>TazWeb handles a home page located in your system wide standard
|
pankso@195
|
94 configuration directory, the path is: /usr/share/webhome.</p>
|
al@188
|
95
|
pankso@195
|
96 <p>The bookmark.txt file is a simple text document with, by default, a
|
pankso@195
|
97 list of links. You can edit this file with you favorite editor and add
|
pankso@195
|
98 bookmark entries or use the Tazweb right click menu. At first start
|
pankso@195
|
99 TazWeb will create and copy your personal bookmarks file to your config
|
al@188
|
100 directory.</p>
|
al@188
|
101
|
pankso@195
|
102 <p>Bookmarks can be handled by TazWeb and you can easily add a bookmark
|
pankso@195
|
103 to your home page with the right click menu item: <i>“Add a bookmark”</i>.
|
al@188
|
104 Tazweb also lets you manage your bookmarks via a nifty CGI web interface.</p>
|
al@188
|
105
|
paul@196
|
106 <p>Note: You can find the default bookmarks.txt in: /usr/share/tazweb
|
pankso@195
|
107 or you can get an original copy with the following command in a terminal:</p>
|
al@188
|
108
|
pankso@36
|
109 <pre>
|
pankso@195
|
110 $ cp -f /usr/share/tazweb/bookmarks.txt $HOME/.config/tazweb
|
pankso@36
|
111 </pre>
|
pankso@36
|
112
|
pankso@3
|
113
|
al@188
|
114 <h3>Start page and URL in argument</h3>
|
al@188
|
115
|
al@188
|
116 <p>The default start page has been defined in the source code and can't be changed and is the
|
al@188
|
117 default SliTaz WebHome but TazWeb accepts a URL as a first argument, you can for example
|
al@188
|
118 execute:</p>
|
al@188
|
119
|
pankso@93
|
120 <pre>
|
pankso@93
|
121 $ tazweb <a href="http://www.slitaz.org/">http://www.slitaz.org/</a>
|
pankso@93
|
122 </pre>
|
al@188
|
123
|
al@188
|
124 <p>In this way you can for example create your own and custom home page in a pretty HTML document
|
al@188
|
125 and start tazweb with a standard desktop file or from the command line:
|
al@188
|
126 tazweb file://$HOME/.config/tazweb/home.html.</p>
|
al@188
|
127
|
al@188
|
128 <p>If you want a custom start page for your Live system or all system users, you can create your
|
al@188
|
129 own slitaz-configs package or edit the HTML file located in /usr/share/webhome/index.html.
|
al@188
|
130 If you modify it, make sure to block slitaz-configs or make a backup because it will be overwritten
|
al@188
|
131 with a slitaz-configs package update.</p>
|
al@188
|
132
|
al@188
|
133 <p>When you start TazWeb from the cmdline with a URL in the argument you don’t have to put http://
|
al@188
|
134 since TazWeb will transform URLs for you.</p>
|
al@188
|
135
|
pankso@93
|
136
|
pankso@93
|
137 <h3>URL and search entry</h3>
|
al@188
|
138
|
pankso@197
|
139 <p>The URL entry in the toolbar lets you enter a website address and shows
|
pankso@197
|
140 the current website location. You can use selection, copy and paste in the
|
pankso@197
|
141 URL entry and don't have to put http:// before a location, Tazweb will
|
pankso@197
|
142 transform URLs for you. To activate a new URL you must press ENTER.</p>
|
al@188
|
143
|
pankso@197
|
144 <p>The search entry lets you search the web at any time using DuckDuck go.
|
pankso@197
|
145 Just enter your query and press ENTER or click on the entry icon to
|
pankso@197
|
146 validate your request.</p>
|
al@188
|
147
|
pankso@3
|
148
|
pankso@3
|
149 <h3>Web applications</h3>
|
al@188
|
150
|
al@188
|
151 <p>TazWeb browser is perfect to launch web applications via a simple desktop file.
|
al@188
|
152 Once created with a simple text editor, the desktop file can stand on the desktop with a nice icon
|
al@188
|
153 or in the standard SliTaz menu.
|
al@188
|
154 Example of a web application launcher that you could name scn.desktop:</p>
|
al@188
|
155
|
pankso@3
|
156 <pre>
|
pankso@3
|
157 [Desktop Entry]
|
pankso@3
|
158 Type=Application
|
pankso@3
|
159 Name=SliTaz SCN
|
pankso@3
|
160 Icon=slitaz-menu
|
pankso@195
|
161 Exec=tazweb --notoolbar http://scn.slitaz.org/
|
pankso@3
|
162 </pre>
|
pankso@3
|
163
|
al@188
|
164
|
pankso@93
|
165 <h3>Bugs and development</h3>
|
al@188
|
166
|
al@188
|
167 <p>TazWeb is an open-source project under a BSD license and all resources are provided by SliTaz
|
al@188
|
168 GNU/Linux, we use a Mercurial repository for code management, discussion and support is done
|
al@188
|
169 through the SliTaz community <a href="http://forum.slitaz.org/">forum</a>.
|
al@188
|
170 If you're missing any features in TazWeb or find any bugs, please post an issue on our bug tracker
|
al@188
|
171 at <a href="http://bugs.slitaz.org/">bugs.slitaz.org</a>.</p>
|
al@188
|
172
|
al@188
|
173 <p>If you want to help and get involved in development, you can start by cloning the TazWeb
|
al@188
|
174 repository and then submit your patch, improved documentation or artwork to the SliTaz mailing list
|
al@188
|
175 or on the <a href="http://scn.slitaz.org/">SCN</a>.
|
al@188
|
176 To clone or browse the TazWeb Hg repository:</p>
|
al@188
|
177
|
pankso@93
|
178 <pre>
|
pankso@93
|
179 $ hg clone <a href="http://hg.slitaz.org/tazweb">http://hg.slitaz.org/tazweb</a>
|
pankso@93
|
180 </pre>
|
pankso@93
|
181
|
al@188
|
182 </main>
|
pankso@3
|
183
|
al@188
|
184 <footer>
|
pascal@132
|
185 Copyright © <span class="year"></span> TazWeb contributors
|
al@188
|
186 </footer>
|
pankso@3
|
187
|
pankso@3
|
188 </body>
|
pankso@3
|
189 </html>
|