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