path: root/h-source/Application/Views/Help/index.php

<?php if (!defined('EG')) die('Direct access not allowed!'); ?>

<?php
// h-source, a web software to build a community of people that want to share their hardware information.
// Copyright (C) 2010  Antonio Gallo (h-source-copyright.txt)
//
// This file is part of h-source
//
// h-source is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// h-source is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with h-source.  If not, see <http://www.gnu.org/licenses/>.
?>

<div class="help_external_box">

	<div class="position_tree_box">
			<a href="<?php echo $this->baseUrl."/home/index/$lang";?>">Home</a> &raquo; help
	</div>

	<div class="help_tables_of_contents">
		Table of contents
		<ul>
			<li><a href="<?php echo $this->currPage."/$lang#wiki-syntax";?>">Wiki syntax</a></li>
			<li><a href="<?php echo $this->currPage."/$lang#compatibility";?>">Compatibility classes</a></li>
			<li><a href="<?php echo $this->currPage."/$lang#discover-hardware";?>">Discover your hardware</a></li>
			<li><a href="<?php echo $this->currPage."/$lang#fully-free";?>">List of fully free Gnu/Linux distributions</a></li>
		</ul>
	</div>
	
	<a name="wiki-syntax"><h1>Wiki syntax</h1></a>

	<h3>List of <?php echo Website::$generalName;?> wiki tags</h3>

	<table class="help_wiki_table" width="100%" border="1px">
		<thead>
			<tr>
				<th>name</th>
				<th>tag</th>
				<th>result</th>
				<th width="40%">description</th>
			</tr>
		</thead>
		<tr>
			<td>bold</td>
			<td>[b]text[/b]</td>
			<td><b>text</b></td>
			<td>text bold</td>
		</tr>
		<tr>
			<td>italic</td>
			<td>[i]text[/i]</td>
			<td><i>text</i></td>
			<td>text italic</td>
		</tr>
		<tr>
			<td>del</td>
			<td>[del]text[/del]</td>
			<td><del>text</del></td>
			<td>text deleted</td>
		</tr>
		<tr>
			<td>underline</td>
			<td>[u]text[/u]</td>
			<td><u>text</u></td>
			<td>text underlined</td>
		</tr>
		<tr>
			<td>head 1</td>
			<td>[h1]text[/h1]</td>
			<td><div class="div_h1">text</div></td>
			<td>head 1</td>
		</tr>
		<tr>
			<td>head 2</td>
			<td>[h2]text[/h2]</td>
			<td><div class="div_h2">text</div></td>
			<td>head 2</td>
		</tr>
		<tr>
			<td>head 3</td>
			<td>[h3]text[/h3]</td>
			<td><div class="div_h3">text</div></td>
			<td>head 3</td>
		</tr>
		<tr>
			<td>paragraph</td>
			<td>[p]text[/p]</td>
			<td><p>text</p></td>
			<td>new paragraph</td>
		</tr>
		<tr>
			<td>list</td>
			<td>[list]list[/list]</td>
			<td>&lt;ul&gt;list&lt;/ul&gt;</td>
			<td>make a list of items</td>
		</tr>
		<tr>
			<td>numbered list</td>
			<td>[enum]list[/enum]</td>
			<td>&lt;ol&gt;list&lt;/ol&gt;</td>
			<td>make a numbered list of items</td>
		</tr>
		<tr>
			<td>list item</td>
			<td>[*]item[/*]</td>
			<td>&lt;li&gt;item&lt;/li&gt;</td>
			<td>ad an item to a list</td>
		</tr>
		<tr>
			<td>code</td>
			<td>[code]some code[/code]</td>
			<td><pre class="code_pre">some code</div></td>
			<td>ad some code</td>
		</tr>
		<tr>
			<td>simple link</td>
			<td>[a]url[/a]</td>
			<td>&lt;a href="url"&gt;url&lt;/a&gt;</td>
			<td>simple link</td>
		</tr>
		<tr>
			<td>link with text</td>
			<td>[a]url|text[/a]</td>
			<td>&lt;a href="url"&gt;text&lt;/a&gt;</td>
			<td>link with text</td>
		</tr>
		<tr>
			<td>notebook</td>
			<td>[notebook]id[/notebook]</td>
			<td>&nbsp</td>
			<td>link to the notebook with the identifier equal to id (the identifier of each device model is written in the page of the device itself, next to the model name)</td>
		</tr>
		<tr>
			<td>wifi</td>
			<td>[wifi]id[/wifi]</td>
			<td>&nbsp</td>
			<td>link to the wifi with the identifier equal to id (the identifier of each device model is written in the page of the device itself, next to the model name)</td>
		</tr>
		<tr>
			<td>videocard</td>
			<td>[videocard]id[/videocard]</td>
			<td>&nbsp</td>
			<td>link to the videocard with the identifier equal to id (the identifier of each device model is written in the page of the device itself, next to the model name)</td>
		</tr>
	</table>

	<h3>Some more examples:</h3>
	
	<table width="100%" border="1px">
		<tr>
			<td>
				<b>List</b>
			</td>
			<td>
				<ul>
					<li>first item</li>
					<li>second item</li>
				</ul>
			</td>
			<td>
				<ul style="list-style-type:none;">
					<li>[list]</li>
					<li>
						<ul style="list-style-type:none;">
							<li>[*]first item[/*]</li>
							<li>[*]second item[/*]</li>
						</ul>
					</li>
					<li>[/list]</li>
				</ul>
			</td>
		</tr>
		<tr>
			<td>
				<b>Numbered list</b>
			</td>
			<td>
				<ol>
					<li>first item</li>
					<li>second item</li>
				</ol>
			</td>
			<td>
				<ul style="list-style-type:none;">
					<li>[enum]</li>
					<li>
						<ul style="list-style-type:none;">
							<li>[*]first item[/*]</li>
							<li>[*]second item[/*]</li>
						</ul>
					</li>
					<li>[/enum]</li>
				</ul>
			</td>
		</tr>
	</table>

	<a name="compatibility"><h1>Compatibility classes</h1></a>

	<a name="notebook-compatibility"><h2>Notebooks</h2></a>
	
	<h3>Class A (Platinum)</h3>
	
	<p>All the notebook devices work with a very good performance. Example: all the devices work, the 3D acceleration is supported</p>

	<h3>Class B (Gold)</h3>

	<p>All the notebook devices work but not at full performance. A typical example: all the devices work, but the 3D acceleration is not supported</p>

	<h3>Class C (Silver)</h3>

	<p>One main device is not supported. Example: the internal wifi card does not work. You need an external USB card</p>

	<h3>Class D (Bronze)</h3>

	<p>More than one device is not supported</p>

	<h3>Class E (Garbage)</h3>

	<p>The notebook does not work with free software</p>

	
	<a name="printer-compatibility"><h2>Printers</h2></a>
	
	<h3>Class A (Full)</h3>
	
	<p>All device functions and features are supported</p>

	<h3>Class B (Partial)</h3>

	<p>Printing supported but possibly at limited speed or print quality; scanning and/or faxing on some multifunction devices may not be supported</p>

	<h3>Class C (None)</h3>

	<p>The printer does not work with free software</p>
	
	
	<a name="scanner-compatibility"><h2>Scanners</h2></a>
	
	<h3>Class A (Full)</h3>
	
	<p>All device functions and features are supported</p>

	<h3>Class B (Partial)</h3>

	<p>Scanning supported but possibly at limited speed or quality; some other features may not be supported</p>

	<h3>Class C (None)</h3>

	<p>The scanner does not work with free software</p>
	
	<a name="discover-hardware"><h1>Discover your hardware</h1></a>
	<div>
		(Thanks <a href="<?php echo $this->baseUrl;?>/issues/view/en/3/1/token">lluvia</a>)
	</div>
	
	<p>In order to know the details of your hardware you can carry out the following actions:</p>
	
	<h3>How to discover the model name of your notebook</h3>
	
	<p>See below your notebook or netbook</p>

	<a name="model-name"><h3>How to discover the model name of your device (if it is not a notebook)</h3></a>

	<h4>If the device is integrated (example: a video card)</h4>

	<p>Open a terminal and type the following command:</p>

	<pre>
		lspci -vmm
	</pre>

	<p>You will obtain the list of your PCI devices, similar to the one written below</p>

	<pre>
		Slot:	03:00.0
		Class:	Network controller
		Vendor:	Broadcom Corporation
		Device:	<b>BCM4311 802.11b/g WLAN</b>
		SVendor:	Hewlett-Packard Company
		SDevice:	Device 1375
		Rev:	02

		Slot:	07:05.0
		Class:	FireWire (IEEE 1394)
		Vendor:	Ricoh Co Ltd
		Device:	<b>R5C832 IEEE 1394 Controller</b>
		SVendor:	Hewlett-Packard Company
		SDevice:	Device 30cf
		Rev:	05
		ProgIf:	10
	</pre>

	<p>The name of each device is written at the "Device" row, after the colon (see the text in bold in the above list)</p>

	<p>You can also write the output of the lspci command to a file by typing:</p>

	<pre>
		lspci -vmm > filename
	</pre>

	<p>where "filename" is the name of the file</p>

	
	<h4>If the device is an USB device (example: an external USB wifi card)</h4>

	<p>Open a terminal and type the following command:</p>

	<pre>
		lsusb -v
	</pre>

	<p>You will obtain the list of your USB devices, similar to the one written below</p>

	<pre>
		Bus 001 Device 002: ID 0846:4260 NetGear, Inc. WG111v3 54 Mbps Wireless [realtek RTL8187B]
		Device Descriptor:
			bLength                18
			bDescriptorType         1
			bcdUSB               2.00
			bDeviceClass            0 (Defined at Interface level)
			bDeviceSubClass         0
			bDeviceProtocol         0
			bMaxPacketSize0        64
			idVendor           0x0846 NetGear, Inc.
			idProduct          0x4260 <b>WG111v3 54 Mbps Wireless [realtek RTL8187B]</b>
			bcdDevice            2.00
			iManufacturer           1
			iProduct                2
			iSerial                 3
			...
			...

		Bus 002 Device 003: ID 08ff:2580 AuthenTec, Inc. AES2501 Fingerprint Sensor
		Device Descriptor:
			bLength                18
			bDescriptorType         1
			bcdUSB               1.10
			bDeviceClass          255 Vendor Specific Class
			bDeviceSubClass       255 Vendor Specific Subclass
			bDeviceProtocol       255 Vendor Specific Protocol
			bMaxPacketSize0         8
			idVendor           0x08ff AuthenTec, Inc.
			idProduct          0x2580 <b>AES2501 Fingerprint Sensor</b>
			bcdDevice            6.23
			iManufacturer           0
			iProduct                1 Fingerprint Sensor
			iSerial                 0
			bNumConfigurations      1
			...
			...
	</pre>

	<p>The name of each device is written at the row starting with "idProduct" (see the text in bold in the above list)</p>

	<p>You can also write the output of the lsusb command to a file by typing:</p>

	<pre>
		lsusb -v > filename
	</pre>

	<p>where "filename" is the name of the file</p>
	
	<!--<h3>How to discover the year of commercialization of your notebook</h3>

	<p>Open a terminal and type the following command:</p>
	
	<pre>
		sudo dmidecode| grep "Release Date"
	</pre>-->

	<h3>How to discover the kernel libre version you are using</h3>

	<p>Open a terminal and type the following command:</p>
	
	<pre>
		uname -r
	</pre>
	
	<h3>How to discover the name of your video card</h3>
	
	<p>Open a terminal and type the following command:</p>
	
	<pre>
		sudo lspci
	</pre>
	
	<p>Then look for the row containing the string <b>VGA</b> or <b>Display controller</b>. You can also try one of the following commands:</p>
	
	<pre>
		lspci | grep "Display controller"
	</pre>
	
	<p>or</p>
	
	<pre>
		lspci | grep "VGA"
	</pre>

	<a name="vendoridproductid"><h3>How to discover the VendorID and the ProductID of your device (VendorID:ProductID code)</h3></a>

	<div>
		(Thanks <a href="http://trisquel.info/en/forum/h-nodecom-new-website-hardware-database#comment-5839">Michał Masłowski</a> and <a href="http://trisquel.info/en/forum/h-nodecom-new-website-hardware-database#comment-5837">Julius22</a>)
	</div>

	<h4>If the device is integrated (example: a video card)</h4>

	<p>Open a terminal and type the following command:</p>
	
	<pre>
		sudo lspci -nnk
	</pre>
	
	<p>You should obtain a list of hardware similar to the one written below</p>
	
	<pre>
	03:00.0 Network controller [0280]: Broadcom Corporation BCM4311 802.11b/g WLAN [<b>14e4:4311</b>] (rev 02)
	Kernel driver in use: b43-pci-bridge
	Kernel modules: ssb
	05:00.0 VGA compatible controller [0300]: nVidia Corporation G86 [GeForce 8400M GS] [<b>10de:0427</b>] (rev a1)
	Kernel modules: nouveau, nvidiafb
	</pre>
	
	<p>The strings in <b>bold</b> and placed inside the square brackets (in the above list) are the code you are looking for. The first set of digits (before the colon) are the <b>VendorID</b>, the second set of digits are the <b>ProductID</b>. In the above example: the VendorID:ProductID code of the wifi card (note the strings "Network controller" and "WLAN") is  <b>14e4:4311</b> while the VendorID:ProductID code of the video card (note the string "VGA") is <b>10de:0427</b></p>
	
	<h4>If the device is an USB device (example: an external USB wifi card)</h4>

	<p>Open a terminal and type the following command:</p>
	
	<pre>
		sudo lsusb
	</pre>
	
	<p>You should obtain a list of hardware similar to the one written below</p>
	
	<pre>
	Bus 001 Device 002: ID <b>0846:4260</b> NetGear, Inc. WG111v3 54 Mbps Wireless [realtek RTL8187B]
	Bus 001 Device 001: ID <b>1d6b:0002</b> Linux Foundation 2.0 root hub
	Bus 002 Device 003: ID <b>08ff:2580</b> AuthenTec, Inc. AES2501 Fingerprint Sensor
	</pre>
	
	<p>The strings in <b>bold</b> (in the above list) are the code you are looking for. The first set of digits (before the colon) are the <b>VendorID</b>, the second set of digits are the <b>ProductID</b>. In the above example: the VendorID:ProductID code of the external USB wifi card (note the strings "Wireless") is  <b>0846:4260</b></p>
	
	
	<h3>How to discover if the video card works</h3>
	
	<p>Install <a href="http://rss-glx.sourceforge.net/">rss-glx</a> by means of the package manager of your distribution or compiling it from source and try some screensavers (for example <b>Skyrocket</b> or <b>Solarwinds</b>). Check if you can play the screensaver (and/or if you can play it smoothly)</p>
	
	<h3>How to discover if the 3D acceleration works</h3>
	
	<p>Try to enable compiz</p>
	
	<h3>How to discover the name of your wifi card</h3>
	
	<p>Open a terminal and type the following command:</p>
	
	<pre>
		sudo lspci
	</pre>
	
	<p>Then look for the row containing the string <b>Wireless</b> or <b>Network controller</b>. You can also try one of the following commands:</p>
	
	<pre>
		lspci | grep "Wireless" 
	</pre>
	
	<p>or</p>
	
	<pre>
		lspci | grep "Network" 
	</pre>
	
	<h3>How to discover the printer driver you are using</h3>
	
	<h4>If you are using cups</h4>
	
	<p>Open a terminal and type the following command:</p>
	
	<pre>
		dpkg-query -W -f '${Version}\n' cups
	</pre>
	
	<h3>How to discover the architecture of your notebook</h3>

	<p>Open a terminal and type the following command:</p>

	<pre>
		dpkg --print-architecture
	</pre>


	<a name="fully-free"><h1>List of fully free GNU/Linux distributions</h1></a>

	<p>They are listed in alphabetical order</p>
	
	<ul>
		<li><a href="http://www.blagblagblag.org/">BLAG</a></li>

		<li><a href="http://dragora.usla.org.ar/wiki/doku.php">Dragora</a></li>

		<li><a href="http://dynebolic.org/">Dynebolic</a></li>

		<li><a href="http://www.gnewsense.org/">gNewSense</a></li>

		<li><a href="http://www.musix.org.ar/">Musix GNU+Linux</a></li>

		<li><a href="http://trisquel.info/en/">Trisquel</a></li>

		<li><a href="http://www.ututo.org/www/">Ututo</a></li>

		<li><a href="http://venenux.org/">Venenux</a></li>
	</ul>
	
</div>