Started translation of kicad master reference file

src/asciidoc/kicad/kicad.adoc

@@ -0,0 +1,396 @@
+Kicad
+=====
+
+:author: The KiCad Team
+:version: 0.1
+:doctype: book
+:toc:
+:toc-placement: preamble
+
+image:images/kicad_logo.png[]
+
+_Reference manual_
+
+[[Copyright]]
+*Copyright*
+
+This document is Copyright © 2010–201 4 by its contributors as listed
+below. You may distribute it and/or modify it under the terms of either
+the GNU General Public License 
+(http://www.gnu.org/licenses/gpl.html[http://www.gnu.org/licenses/gpl.html]),
+version 3 or later, or the Creative Commons Attribution License (
+http://creativecommons.org/licenses/by/3.0/[http://creativecommons.org/licenses/by/3.0/]
+), version 3.0 or later.
+
+All trademarks within this guide belong to their legitimate owners.
+
+Contributors
+
+Jean-Pierre Charras, Fabrizio Tappero.
+
+Feedback
+
+Please direct any comments or suggestions about this document to the
+kicad mailing list: _https://launchpad.net/~kicad-developers_
+
+Acknowledgments
+
+None
+
+V ersion
+
+2014, march 17 .
+
+Note for Mac users
+
+The KiCad support for the Apple OS X operating system is experimental.
+
+Introduction
+
+KiCad
+
+KiCad is an open-source software tool for the creation of electronic
+schematic diagrams and PCB artwork. Beneath its singular surface, kicad
+incorporates an elegant ensemble of the following stand-alone software
+tools:
+
+* *Kicad* : project manager
+* *Eeschema* : schematic editor
+* *CvPcb* : footprint selector
+* *Pcbnew* : circuit board layout editor
+* *GerbView* : Gerber viewer
+
+3 utilities are included
+
+* *Bitmap2Component* : component maker for logos (Creates a schematic
+component or a footprint from a bitmap picture).
+* *PcbCalculator* : A calculator that is helpfull to calculate
+components for regulators, track witdth versus current, transmission
+lines...
+* *PlEditor* : Page Layout Editor.
+
+At the time of writing, KiCad is considered mature and can be used for
+the successful development and maintenance of complex electronic boards.
+
+Kicad does not present any board-size limitation and it can easily
+handle up to 16 copper layers and up to 12 technical layers.
+
+Kicad can create all the files necessary for building printed boards:
+
+* Gerber files for photo-plotters
+* drilling files
+* component location files
+* and a lot more.
+
+Being open source (GPL licensed), kicad represents the ideal tool for
+projects oriented towards the creation of electronic hardware with an
+open-source flavour.
+
+Kicad is available for Linux, Windows and Apple OS X (experimental).
+
+Installation and configuration
+
+Display options
+
+Pcbnew needs the support of OpenGL v2.1 or more .
+
+Initialization of the default configuration
+
+A default configuration file named _kicad.pro_ is supplied in
+kicad/template. It serves as a template for any new project.
+
+*The default file* _kicad.pro_ __* can be freely modified if necessary,
+mainly to set the list of libraries files loaded by Eeschema or
+Pcbnew.__*
+
+Some other parameters (default text size, default line thickness, mainly
+for Pcbnew) are stored.
+
+Verify you have a write acces to kicad/template/kicad.pro
+
+Run kicad and load _kicad.pro_ project.
+
+Run * * Eeschema via kicad. Modify and update the Eeschema
+configuration, and mainly the list of libraries you want to use each
+time you create new projects.
+
+Run * Pcbnew* via kicad. Modify and update the Pcbnew configuration
+
+Kicad: principles of use
+
+In order to manage a Kicad project: schematic files, printed circuit
+board files, supplementary libraries, manufacturing files for
+photo-tracing, drilling and automatic component placement files, it is
+recommended to create a project as follows:
+
+* Create a working directory for the project (using KiCad or by other
+means).
+* In this directory, use Kicad to create a project file (file with
+extension .pro) via the “Start a new project” icon.
+
+It is strongly recommended to use the same name for both project file
+and its directory.
+
+Kicad creates a file with a .pro extension that maintains a number of
+parameters for project management (such as the filename of the principal
+schematic, list of libraries used in the schematics and PCBs). Default
+names of both principal schematic and printed circuit board files are
+derived from the name of the project. Thus, if a project called
+_example.pro_ was created in a directory called _example_ , the default
+files will be created:
+
+[width="100%",cols="27%,73%",]
+|=================================================================
+|example.pro |project management file.
+|example.sch |main schematic file.
+|example. kicad_pcb |printed circuit board file.
+|example.net |netlist file.
+|example.xxx |various files created by the other utility programs.
+|example.cache.lib a|
+cache file of libraries used in the schematic
+
+(backup of the components used)
+
+|=================================================================
+
+Use Kicad
+
+Main window
+
+image:images/10000000000002B5000001AB64B9B213.png[10000000000002B5000001AB64B9B213_png]
+
+The main KiCad window is composed of a project tree view, a launch pane
+containing buttons used to run the various software tools, and a message
+window. The menu and the toolbar can be used to create, read and save
+project files.
+
+Utility launch pane
+
+Kicad allows you to run all stand alone software tools that come with
+it.
+
+The launch pane is made of the above 7 buttons that correspond to the
+following commands (from left to right):
+
+image:images/10000000000001EC0000004F07F2B654.png[10000000000001EC0000004F07F2B654_png]
+
+[width="38%",cols="16%,14%,14%,14%,14%,14%,14%",]
+|===================
+|1 |2 |3 |4 |5 |6 |7
+|===================
+
+[width="100%",cols="4%,20%,76%",]
+|=======================================================================
+|1 |*Eeschema* |The schematic editor
+
+|2 |*Cvpcb* |A tool to create the association between components and the
+corresponding footprints
+
+|3 |*Pcbnew* |The board layout editor
+
+|4 |*Gerbview* |A GERBER file viewer. Its also can show drill files.
+
+|5 |*Bitmap2component* |A tool to build a footprint or a component from
+a B&W bitmap image to create logos
+
+|6 |*Pcb Calculator* |A tool to calculate track widths, any many other
+things
+
+|7 |*Pl Editor* |The Page Layout editor, to create/customize frame
+references.
+|=======================================================================
+
+Project tree view
+
+[width="100%",cols="29%,71%",]
+|=======================================================================
+|image:images/10000000000000C60000009255B0301C.png[10000000000000C60000009255B0301C_png]
+a|
+Double-clicking on the Eeschema icons runs the schematic editor which in
+this case will open the file pic_programmer .sch.
+
+Double-clicking on the Pcbnew icon runs the layout editor, in this case
+opening the file pic_programmer . kicad_pcb
+
+Right clicking on any of the files in the project tree allows generic
+files manipulation.
+
+|=======================================================================
+
+Top toolbar
+
+image:images/10000000000000E900000027B0999D75.png[10000000000000E900000027B0999D75_png]
+
+Kicad top toolbar allows for some basic files operation (from left to
+right).
+
+[width="100%",cols="26%,74%",options="header",]
+|=======================================================================
+|image:images/100000000000002C00000027822C5914.png[100000000000002C00000027822C5914_png]
+|Create a project file. If the template kicad.pro is found in
+kicad/template, it is copied into the working directory.
+|image:images/100000000000002500000029C403AB20.png[100000000000002500000029C403AB20_png]
+|Create a project from a template.
+
+|image:images/10000000000000230000002995442CF9.png[10000000000000230000002995442CF9_png]
+|Open an existing project.
+
+|image:images/100000000000002700000029A7BBB537.png[100000000000002700000029A7BBB537_png]
+|Update and save the current project tree.
+
+|image:images/10000000000000260000002421A88B39.png[10000000000000260000002421A88B39_png]
+|Create a zip archive of the whole project. This includes schematic
+files, libraries, pcb, etc.
+
+|image:images/1000000000000024000000248581A3AE.png[1000000000000024000000248581A3AE_png]
+|Redraw the tree list, useful after a tree change.
+|=======================================================================
+
+Using templates:
+
+Definitions
+
+A template is a directory of files, which includes a directory of
+metadata.
+
+The template system name (SYSNAME) is the directory name under which the
+template files are stored. The metadata directory (METADIR) contains
+pre-defined files which provide information about the template.
+
+All files and directories in a template are copied to the new project
+path when a project is created using a template, except METADIR.
+
+All files and directories which start with SYSNAME will have SYSNAME
+replaced by the new project file name, excluding the file extension.
+
+Templates:
+
+They facilitate the easy setup of projects which have common attributes
+such as pre-defined board outlines, connector positions, schematic
+elements, design rules, etc.
+
+_Metadata_
+
+A template's METADIR must contain the required files, and might
+optionally contain any of the optional files
+
+_Required Files:_
+
+*meta/info.html*
+
+Contains html formatted information about the template which is used by
+the user to determine if the template is what they are after. The
+<title> tag determines the actual name of the template that is exposed
+to the user for template selection.
+
+Using html to format this document means that images can be in-lined
+without having to invent a new scheme.
+
+Only a basic HTML language can be used to format this document.
+
+_Optional Files:_
+
+*meta/icon.png*
+
+A 64 x 64 pixels PNG icon file which is used as a clickable icon in the
+template selection dialog.
+
+_Example:_
+
+Here is a template for a raspberrypi-gpio board:
+
+image:images/10000000000001BA0000006F670E0EA3.png[10000000000001BA0000006F670E0EA3_png]
+
+And the meta data info:
+
+image:images/1000000000000163000000735475F846.png[1000000000000163000000735475F846_png]
+
+brd.png is an optional file
+
+Here is an info.html file sample:
+
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<HTML>
+
+<HEAD>
+
+<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html;
+charset=windows-1252">
+
+<TITLE>Raspberry Pi - Expansion Board</TITLE>
+
+<META NAME="GENERATOR" CONTENT="LibreOffice 3.6 (Windows)">
+
+<META NAME="CREATED" CONTENT="0;0">
+
+<META NAME="CHANGED" CONTENT="20121015;19015295">
+
+</HEAD>
+
+<BODY LANG="fr-FR" DIR="LTR">
+
+<P>This project template is the basis of an expansion board for the
+
+<A HREF="http://www.raspberrypi.org/" TARGET="blank">Raspberry Pi $25
+
+ARM board.</A> <BR><BR>This base project includes a PCB edge defined
+
+as the same size as the Raspberry-Pi PCB with the connectors placed
+
+correctly to align the two boards. All IO present on the Raspberry-Pi
+
+board is connected to the project through the 0.1&quot; expansion
+
+headers. <BR><BR>The board outline looks like the following:
+
+</P>
+
+<P><IMG SRC="brd.png" NAME="brd" ALIGN=BOTTOM WIDTH=680 HEIGHT=378
+BORDER=0><BR><BR><BR><BR>
+
+</P>
+
+<P>(c)2012 Brian Sidebotham<BR>(c)2012 Kicad Developers</P>
+
+</BODY>
+
+</HTML>
+
+_Operation_
+
+The KiCad File menu New shows 2 option:
+
+image:images/1000000000000185000000F2ADA0CF8E.png[1000000000000185000000F2ADA0CF8E_png]
+
+* *Blank* *Project* Create a blank project by just copying
+template/kicad.pro to the current folder.
+* *Project* __* from Template__* Open the template selection dialog. The
+template selection dialog has a list of icons, and a display window. A
+single click on a template's icon on the left will load that templates
+info.html metadata file and display it in the display window. A click on
+the OK button starts the new project creation. The template will be
+copied to the new project location ( excluding METADIR as mentioned
+earlier ) and any files that match the string replacement rules will be
+renamed to reflect the new project's name.
+
+image:images/100000000000027E000001DCE9DD870D.png[100000000000027E000001DCE9DD870D_png]
+
+After selection of a template:
+
+image:images/100000000000028C000002A7A0200039.png[100000000000028C000002A7A0200039_png]
+
+_Templates Location:_
+
+The list of available templates are gathered from the following sources:
+
+* For sytem templates: <kicad bin dir>/../share/template/
+* For user templates On Unix: ~/ kicad/templates/ On Windows:
+`C:\Documents and Settings\username\My Documents`
+kicad
+templates
+ On Mac: ~/Documents /kicad/templates/
+* When the environment variable KICAD_PTEMPLATES is defined, there is a
+third page: Portable Templates, which lists templates found in
+KICAD_PTEMPLATES path.
+