summaryrefslogtreecommitdiff
path: root/docs/src/index.tmpl
blob: 68e19d77d178da8b98b10946556607152b822ac8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<HTML>
<HEAD>
<META http-equiv="Content-Type" content="text/html;charset=utf-8">
<TITLE> LinuxCNC Documentation - HTML version </TITLE>
</HEAD>
<BODY>

<!-- Even though this template file will open in a browser do not open it in a browser it to test changes
     open the /html/index.html file in your browser after building the documents
     If this is the .html file do not edit it, edit the .tmpl file then build the documents -->

<p>This documentation refers to LinuxCNC version <strong>@VERSION@</strong>.</p>
<UL>
<LI>Other languages available: <A HREF="index_es.html">Espa&ntilde;ol</A> <A HREF="index_fr.html">Fran&ccedil;ais</A>
<p></p>
<LI><A HREF="common/overleaf.html">LinuxCNC Document Overleaf</A>
<LI><A HREF="gcode.html">LinuxCNC G Code Quick Reference</A>
<LI><A HREF="http://wiki.linuxcnc.org/cgi-bin/wiki.pl">LinuxCNC Wiki Community</A>
<p></p>
<LI><a name="Getting Started"></a>Getting Started with LinuxCNC
	<UL>
	<LI><A HREF="common/System_Requirements.html">System Requirements</A>
	<LI><A HREF="common/Getting_LinuxCNC.html">Getting LinuxCNC</A>
	<LI><A HREF="common/Updating_LinuxCNC.html">Updating LinuxCNC</A>
	<LI><A HREF="quickstart/stepper_quickstart.html">Stepper Quickstart</A>
	<LI><A HREF="config/stepconf.html">Stepper Configuration Wizard</A>
	<LI><A HREF="config/pncconf.html">Mesa Configuration Wizard</A>
	<LI><A HREF="config/copy_and_run.html">Running LinuxCNC</A>
	<LI><A HREF="common/Stepper_Diagnostics.html">Stepper Diagnostics</A>
	<LI><A HREF="common/Linux_FAQ.html">Linux FAQ</A>
	</UL>
<p></p>
<LI><a name="User Manual"></a>Using LinuxCNC
	<UL>
	<LI><A name="General User Information"></A>General User Information
		<UL>
			<LI><A HREF="common/userforeword.html">User Foreword</A>
			<LI><A HREF="common/user_intro.html">LinuxCNC User Introduction</A>
			<LI><A HREF="common/User_Concepts.html">Important User Concepts</A>
			<LI><A HREF="gcode/machining_center.html">CNC Machine Overview</A>
			<LI><A HREF="lathe/lathe-user.html">Lathe User Information</A>
		</UL>
		<LI><A name="User Interfaces"></A>User Interfaces
		<UL>
			<LI><A HREF="gui/axis.html">Axis GUI</A>
			<LI><A HREF="gui/touchy.html">Touchy GUI</A>
			<LI><A HREF="gui/ngcgui.html">NGCGUI</A>
			<LI><A HREF="gui/tklinuxcnc.html">TkLinuxCNC GUI</A>
			<LI><A HREF="gui/mini.html">Mini GUI</A>
			<LI><A HREF="gui/keystick.html">Keystick GUI</A>
		</UL>
	<LI><A name="G code Programming"></A>G code Programming
		<UL>
			<LI><A HREF="gcode/coordinates.html">Coordinate System</A>
			<LI><A HREF="gcode/tool_compensation.html">Tool Compensation</A>
			<LI><A HREF="gui/tooledit.html">Tool Table Editor</A>
			<LI><A HREF="gcode/overview.html">G Code Overview</A>
			<LI><A HREF="gcode/gcode.html">G Codes</A>
			<LI><A HREF="gcode/m-code.html">M Codes</A>
			<LI><A HREF="gcode/o-code.html">O Codes</A>
			<LI><A HREF="gcode/other-code.html">Other Codes</A>
			<LI><A HREF="examples/gcode.html">G Code Examples</A>
			<LI><A HREF="gui/image-to-gcode.html">Image to G Code</A>
			<LI><A HREF="gcode/rs274ngc.html">RS274/NGC Differences</A>
		</UL>
	</UL>
<p></p>
<LI><a name="Integrator Manual"></a>Configuring LinuxCNC
	<UL>
	<LI><A name="General Integrator Information"></A>General Integrator Information
		<UL>
			<LI><A HREF="common/Integrator_Concepts.html">Integrator Concepts</A>
			<LI><A HREF="install/Latency_Test.html">Latency Test</A>
			<LI><A HREF="common/starting-emc.html">Starting LinuxCNC</A>
			<LI><A HREF="motion/tweaking_steppers.html">Stepper Tuning</A>
		</UL>
	<LI><A name="Configuration"></A>Configuration
		<UL>
			<LI><A HREF="config/ini_config.html">INI Configuration</A>
			<LI><A HREF="config/ini_homing.html">Homing Configuration</A>
			<LI><A HREF="config/lathe_config.html">Lathe Configuration</A>
			<LI><A HREF="hal/haltcl.html">HAL TCL Files</A>
			<LI><A HREF="config/stepper.html">Stepper Configuration</A>
		</UL>

	<LI><A name="Virtual Control Panels"></A>Virtual Control Panels
		<UL>
			<LI><A HREF="hal/pyvcp.html">Python Virtual Control Panel</A>
			<LI><A HREF="hal/pyvcp_examples.html">PyVCP Examples</A>
			<LI><A HREF="gui/gladevcp.html">Glade Virtual Control Panel</A>
		</UL>
	<LI><A name="User Interface Programming"></A>User Interface Programming
		<UL>
			<LI><A HREF="gui/halui.html">HAL User Interface</A>
			<LI><A HREF="hal/halui_examples.html">HAL UI examples</A>
			<LI><A HREF="common/python-interface.html">Python Interface</A>
		</UL>
	<LI><A name="Hardware Drivers"></A>Hardware Drivers
		<UL>
			<LI><A HREF="hal/parallel_port.html">Parallel Port Driver</A>
			<LI><A HREF="drivers/AX5214H.html">AX5214H Driver</A>
			<LI><A HREF="drivers/GM.html">General Mechatronics GM6-PCI Driver</A>
			<LI><A HREF="drivers/GS2.html">GS2 Driver</A>
			<LI><A HREF="drivers/hostmot2.html">Mesa HostMot2 Driver</A>
			<LI><A HREF="drivers/motenc.html">Motenc Driver</A>
			<LI><A HREF="drivers/opto22.html">Opto22 Driver</A>
			<LI><A HREF="drivers/pico_ppmc.html">Pico Drivers</A>
			<LI><A HREF="drivers/pluto_p.html">Pluto P Driver</A>
			<LI><A HREF="drivers/servo_to_go.html">Servo To Go Driver</A>
			<LI><A HREF="drivers/shuttlexpress.html">ShuttleXpress Driver</A>
			<LI><A HREF="drivers/VFS11.html">VFS11 Driver</A>
		</UL>
	<LI><A name="Classicladder PLC"></A>Classicladder PLC (Programmable Logic Controller)
		<UL>
			<LI><A HREF="ladder/ladder_intro.html">Classicladder Introduction</A>
			<LI><A HREF="ladder/classic_ladder.html">ClassicLadder Programming</A>
			<LI><A HREF="ladder/ladder_examples.html">ClassicLadder Examples</A>
		</UL>
	<LI><A name="Hardware Examples"></A>Hardware Examples
		<UL>
			<LI><A HREF="examples/pci_parallel_port.html">PCI Parallel Port Example</A>
			<LI><A HREF="examples/spindle.html">Spindle Control Example</A>
			<LI><A HREF="examples/mpg.html">MPG Example</A>
			<LI><A HREF="examples/gs2_example.html">GS2 Example</A>
		</UL>
	<LI><A name="Hardware Abstract Layer"></A>HAL the Hardware Abstract Layer
		<UL>
			<LI><A HREF="hal/intro.html">HAL Introduction</A>
			<LI><A HREF="hal/basic_hal.html">Basic HAL Tutorial</A>
			<LI><A HREF="config/emc2hal.html">Core HAL Components</A>
			<LI><A HREF="hal/components.html">HAL Component List</A>
			<LI><A HREF="hal/rtcomps.html">HAL Component Descriptions</A>
			<LI><A HREF="hal/halshow.html">Halshow</A>
		</UL>
	<LI><A name="Advanced Topics"></A>Advanced Topics
		<UL>
			<LI><A HREF="hal/tutorial.html">Advanced HAL Tutorial</A>
			<LI><A HREF="hal/hal-examples.html">HAL Examples</A>
			<LI><A HREF="hal/comp.html">Comp HAL Component Generator</A>
			<LI><A HREF="hal/halmodule.html">Creating Userspace Python Components</A>
			<LI><A HREF="hal/canonical-devices.html">Canonical Device Interfaces</A>
			<LI><A HREF="hal/tools.html">HAL Tools</A>
			<LI><A HREF="motion/kinematics.html">Kinematics</A>
			<LI><A HREF="motion/pid_theory.html">PID theory</A>
			<LI><A HREF="remap/structure.html">Remapping: Extending LinuxCNC</A>
		</UL>
	</UL>
<p></p>
<LI><a name="Developer Manual"></a>Developer Information
	<UL>
	<LI><A HREF="hal/general_ref.html">General Reference</A>
	<LI><A HREF="code/Code_Notes.html">Code Notes</A>
	<LI><A HREF="code/NML_Messages.html">NML Messages</A>
	<LI><A HREF="code/Style_Guide.html">Style Guide</A>
	<LI><A HREF="code/Contributing-to-LinuxCNC.html">Contributing to LinuxCNC</A>
	</UL>
<p></p>
<LI><a name="Glossary, Copyright"></a>Glossary, Copyright
	<UL>	
	<LI><A HREF="common/emc-history.html">LinuxCNC History</A>
	<LI><A HREF="common/Glossary.html">Glossary</A>
	<LI><A HREF="common/GPLD_Copyright.html">Copyright and Documentation License</A>
	</UL>
<p></p>
<p>The following Manual Pages can be viewed locally in a terminal by typing in
man name of component. For example man axis-remote.</p>
<p></p>