|
Lines 1-8
Link Here
|
| 1 |
.\" Hey, EMACS: -*- nroff -*- |
1 |
.\" Hey, EMACS: -*- nroff -*- |
| 2 |
.\" First parameter, NAME, should be all caps |
2 |
.\" First parameter, NAME, should be all caps |
| 3 |
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
3 |
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
| 4 |
.\" other parameters are allowed: see man(7), man(1) |
4 |
.\" other parameters are allowed: see man(7), man(1) |
| 5 |
.TH PIKLAB SECTION "April 11, 2007" |
|
|
| 6 |
.\" Please adjust this date whenever revising the manpage. |
5 |
.\" Please adjust this date whenever revising the manpage. |
| 7 |
.\" |
6 |
.\" |
| 8 |
.\" Some roff macros, for reference: |
7 |
.\" Some roff macros, for reference: |
|
Lines 15-145
Link Here
|
| 15 |
.\" .br insert line break |
14 |
.\" .br insert line break |
| 16 |
.\" .sp <n> insert n+1 empty lines |
15 |
.\" .sp <n> insert n+1 empty lines |
| 17 |
.\" for manpage-specific macros, see man(7) |
16 |
.\" for manpage-specific macros, see man(7) |
| 18 |
.SH PIKLAB-PROG \- Commandline program for PIC-microcontroller programming. |
17 |
.TH "PIKLAB" "1" "April 11, 2007" "" "" |
| 19 |
.SH SYNOPSIS |
18 |
.SH "NAME" |
| 20 |
.B piklab-prog [Qt-options] [KDE-options] [options] [file] |
19 |
piklab\-prog \- Commandline program for PIC\-microcontroller programming. |
| 21 |
.RI |
|
|
| 22 |
|
20 |
|
| 23 |
.br |
21 |
.SH "SYNOPSIS" |
| 24 |
.SH DESCRIPTION |
22 |
.B piklab\-prog [Qt\-options] [KDE\-options] [options] [file] |
| 25 |
This manual page documents briefly the |
23 |
|
| 26 |
.B piklab-prog command. |
24 |
.SH "DESCRIPTION" |
| 27 |
.PP |
|
|
| 28 |
.\" TeX users may be more comfortable with the \fB<whatever>\fP and |
25 |
.\" TeX users may be more comfortable with the \fB<whatever>\fP and |
| 29 |
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, |
26 |
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, |
| 30 |
.\" respectively. |
27 |
.\" respectively. |
| 31 |
\fBPiklab-prog\fP is a command line tool, which can be used to program microcontrollers with program and data, stored in a HEX-file to a connected programmer. It supports the most common serial, parallel and usb programmers, like ICD2, Pickit2, PicStart+) and debuggers (ICD2). |
28 |
\fBPiklab\-prog\fP is a command line tool, which can be used to program microcontrollers with program and data, stored in a HEX\-file to a connected programmer. It supports the most common serial, parallel and usb programmers, like ICD2, Pickit2, PicStart+) and debuggers (ICD2). |
| 32 |
|
29 |
|
| 33 |
.SH OPTIONS |
30 |
.SH "OPTIONS" |
| 34 |
This program follows the usual GNU command line syntax, with long |
31 |
This program follows the usual GNU command line syntax, with long |
| 35 |
options starting with two dashes (`-'). |
32 |
options starting with two dashes ('\-'). |
| 36 |
A summary of options is included below. |
33 |
A summary of options is included below. |
| 37 |
.TP |
34 |
.TP |
| 38 |
.B \-h, \-\-help |
35 |
.B GENERIC OPTIONS: |
| 39 |
Show summary of options. |
|
|
| 40 |
.TP |
36 |
.TP |
| 41 |
.B \-v, \-\-version |
37 |
.B \-h, \-\-help |
| 42 |
Show version of program. |
38 |
Show summary of options. |
| 43 |
.TP |
39 |
.TP |
| 44 |
.B \-\-help-qt |
40 |
.B \-\-help\-qt |
| 45 |
Show Qt specific options |
41 |
Show Qt specific options. |
| 46 |
.TP |
42 |
.TP |
| 47 |
.B \-\-help-kde |
43 |
.B \-\-help\-kde |
| 48 |
Show KDE specific options |
44 |
Show KDE specific options. |
| 49 |
.TP |
45 |
.TP |
| 50 |
.B \-\-help-all |
46 |
.B \-\-help\-all |
| 51 |
Show all options |
47 |
Show all options. |
| 52 |
.TP |
48 |
.TP |
| 53 |
.B \-\-author |
49 |
.B \-\-author |
| 54 |
Show author information |
50 |
Show author information. |
|
|
51 |
.TP |
| 52 |
.B \-v, \-\-version |
| 53 |
Show version information. |
| 55 |
.TP |
54 |
.TP |
| 56 |
.B \-\-license |
55 |
.B \-\-license |
| 57 |
Show license information |
56 |
Show license information. |
| 58 |
.TP |
57 |
.TP |
| 59 |
.B \-\- |
58 |
.B \-\- |
| 60 |
End of options |
59 |
End of options. |
|
|
60 |
|
| 61 |
.br |
61 |
.br |
| 62 |
.B Options: |
62 |
.TP |
|
|
63 |
.B SPECIFIC OPTIONS: |
| 64 |
.TP |
| 63 |
.B \-c, \-\-command <name> |
65 |
.B \-c, \-\-command <name> |
| 64 |
Perform the requested command. |
66 |
Perform the requested command. |
| 65 |
.TP |
67 |
.TP |
| 66 |
.B \-\-command-list |
68 |
.B \-\-command\-list |
| 67 |
Return the list of recognized commands. |
69 |
Return the list of recognized commands. |
| 68 |
.TP |
70 |
.TP |
| 69 |
.B \-\-debug |
71 |
.B \-\-debug |
| 70 |
Display debug messages. |
72 |
Display debug messages. |
|
|
73 |
.TP |
| 74 |
.B \-\-extra\-debug |
| 75 |
Display extra debug messages. |
| 71 |
.TP |
76 |
.TP |
| 72 |
.B \-\-extra-debug |
77 |
.B \-\-max\-debug |
| 73 |
Display extra debug messages. |
78 |
Display all debug messages. |
| 74 |
.TP |
79 |
.TP |
| 75 |
.B \-\-max-debug |
80 |
.B \-\-lowlevel\-debug |
| 76 |
Display all debug messages. |
81 |
Display low level debug messages. |
| 77 |
.TP |
82 |
.TP |
| 78 |
.B \-\-quiet |
83 |
.B \-\-quiet |
| 79 |
Do not display messages. |
84 |
Do not display messages. |
| 80 |
.TP |
85 |
.TP |
| 81 |
.B \-f, \-\-force |
86 |
.B \-f, \-\-force |
| 82 |
Overwrite files and answer "yes" to questions. |
87 |
Overwrite files and answer "yes" to questions. |
| 83 |
.TP |
88 |
.TP |
| 84 |
.B \-i, \-\-cli |
89 |
.B \-i, \-\-cli |
| 85 |
Interactive mode |
90 |
Interactive mode. |
| 86 |
.TP |
91 |
.TP |
| 87 |
.B \-r, \-\-range <name> |
92 |
.B \-r, \-\-range <name> |
| 88 |
Memory range to operate on. |
93 |
Memory range to operate on. |
| 89 |
.TP |
94 |
.TP |
| 90 |
.B \-\-range-list |
95 |
.B \-\-range\-list |
| 91 |
Return the list of memory ranges. |
96 |
Return the list of memory ranges. |
| 92 |
.TP |
97 |
.TP |
| 93 |
.B \-p, \-\-programmer <name> |
98 |
.B \-p, \-\-programmer <name> |
| 94 |
Programmer to use. |
99 |
Programmer to use. |
| 95 |
.TP |
100 |
.TP |
| 96 |
.B \-\-programmer-list |
101 |
.B \-\-programmer\-list |
| 97 |
Return the list of supported programmers. |
102 |
Return the list of supported programmers. |
|
|
103 |
.TP |
| 104 |
.B \-h, \-\-hardware <name> |
| 105 |
Programmer hardware configuration to use (for direct programmer). |
| 106 |
.TP |
| 107 |
.B \-\-hardware\-list |
| 108 |
Return the list of supported programmer hardware configurations. |
| 98 |
.TP |
109 |
.TP |
| 99 |
.B \-d, \-\-device <name> |
110 |
.B \-d, \-\-device <name> |
| 100 |
Target device. |
111 |
Target device. |
| 101 |
.TP |
112 |
.TP |
| 102 |
.B \-\-device-list |
113 |
.B \-\-device\-list |
| 103 |
Return the list of supported devices. |
114 |
Return the list of supported devices. |
| 104 |
.TP |
115 |
.TP |
| 105 |
.B \-f, \-\-format <name> |
116 |
.B \-f, \-\-format <name> |
| 106 |
HEX output file format. |
117 |
HEX output file format. |
| 107 |
.TP |
118 |
.TP |
| 108 |
.B \-\-format-list |
119 |
.B \-\-format\-list |
| 109 |
Return the list of supported HEX file formats. |
120 |
Return the list of supported HEX file formats. |
| 110 |
.TP |
121 |
.TP |
| 111 |
.B \-t, \-\-port <name> |
122 |
.B \-t, \-\-port <name> |
| 112 |
Programmer port ("usb" or device such as "/dev/ttyS0") |
123 |
Programmer port ("usb" or device such as "/dev/ttyS0"). |
| 113 |
.TP |
124 |
.TP |
| 114 |
.B \-\-port-list |
125 |
.B \-\-port\-list |
| 115 |
Return the list of detected ports. |
126 |
Return the list of detected ports. |
| 116 |
.TP |
127 |
.TP |
| 117 |
.B \-\-firmware-dir <dir> |
128 |
.B \-\-firmware\-dir <dir> |
| 118 |
Firmware directory. |
129 |
Firmware directory. |
| 119 |
.TP |
130 |
.TP |
| 120 |
.B \-\-target-self-powered |
131 |
.B \-\-target\-self\-powered <true|false> |
| 121 |
Indicates that device is self-powered. |
132 |
Set if target device is self-powered. |
| 122 |
.br |
133 |
|
| 123 |
.SH Arguments: |
|
|
| 124 |
.B file <HEX-filename for programming>. |
| 125 |
.br |
134 |
.br |
| 126 |
.sp 2 |
135 |
.TP |
| 127 |
.SH SEE ALSO |
136 |
.B SUPPORTED COMMANDS: |
| 128 |
.BR piklab-prog (1), |
137 |
.TP |
| 129 |
.BR piklab-hex (1), |
138 |
.B connect |
| 130 |
.BR gputils (1), |
139 |
Connect programmer. |
| 131 |
.BR sdcc (1). |
140 |
.TP |
|
|
141 |
.B run |
| 142 |
Run device (release reset). |
| 143 |
.TP |
| 144 |
.B stop |
| 145 |
Stop device (hold reset). |
| 146 |
.TP |
| 147 |
.B program |
| 148 |
Program device memory: "program <hexfilename>". |
| 149 |
.TP |
| 150 |
.B verify |
| 151 |
Verify device memory: "verify <hexfilename>". |
| 152 |
.TP |
| 153 |
.B read |
| 154 |
Read device memory: "read <hexfilename>". |
| 155 |
.TP |
| 156 |
.B erase |
| 157 |
Erase device memory. |
| 158 |
.TP |
| 159 |
.B blank_check |
| 160 |
Blank check device memory. |
| 161 |
.TP |
| 162 |
.B upload_firmware |
| 163 |
Upload firmware to programmer: "upload_firmware <hexfilename>". |
| 164 |
|
| 132 |
.br |
165 |
.br |
| 133 |
.SH AUTHORS |
166 |
.TP |
| 134 |
piklab was written by Nicolas Hadacek and many others, including: |
167 |
.B ARGUMENTS: |
|
|
168 |
.TP |
| 169 |
.B file |
| 170 |
HEX filename for programming. |
| 135 |
|
171 |
|
| 136 |
* Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. |
172 |
.SH "SEE ALSO" |
|
|
173 |
.BR piklab (1), |
| 174 |
.BR piklab\-hex (1), |
| 175 |
.BR piklab\-coff (1). |
| 137 |
|
176 |
|
|
|
177 |
.SH "AUTHORS" |
| 178 |
Piklab was written by Nicolas Hadacek and many others, including: |
| 179 |
* Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. |
| 138 |
* Keith Baker: direct programmer support for 16F7X devices. |
180 |
* Keith Baker: direct programmer support for 16F7X devices. |
| 139 |
* Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. |
181 |
* Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. |
| 140 |
* Craig Franklin: author of gputils (disassembler and coff parser). |
182 |
* Craig Franklin: author of gputils (disassembler and coff parser). |
| 141 |
* Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. |
183 |
* Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. |
| 142 |
* Stephen Landamore: author of LPLAB (microchip command-line programmer). |
184 |
* Stephen Landamore: author of LPLAB (microchip command\-line programmer). |
| 143 |
* Brian C. Lane: original code for direct programming. |
185 |
* Brian C. Lane: original code for direct programming. |
| 144 |
* Sébastion Laoût: author of Likeback. |
186 |
* Sébastion Laoût: author of Likeback. |
| 145 |
* Nestor A. Marchesini: tests of PicStart+ programmer. |
187 |
* Nestor A. Marchesini: tests of PicStart+ programmer. |
|
Lines 152-162
Link Here
|
| 152 |
* Alain Portal: French translation. |
194 |
* Alain Portal: French translation. |
| 153 |
* Stefan von Halenbach: German translation. |
195 |
* Stefan von Halenbach: German translation. |
| 154 |
* Nagy Lázló: Hungarian translation. |
196 |
* Nagy Lázló: Hungarian translation. |
| 155 |
.sp 2 |
|
|
| 156 |
.SH COPYRIGHT |
| 157 |
This is free software. You may redistribute copies of it under the terms of the GNU General Public License |
| 158 |
<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law. |
| 159 |
|
197 |
|
|
|
198 |
.SH "COPYRIGHT" |
| 199 |
This is free software. You may redistribute copies of it under the terms of the GNU General Public License |
| 200 |
<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law. |
| 160 |
.PP |
201 |
.PP |
| 161 |
This manual page was written by Stefan <vonHalenbach@users.sf.net>, |
202 |
This manual page was written by Stefan <vonHalenbach@users.sf.net>, |
| 162 |
for the Debian project (but may be used by others). |
203 |
for the Debian project (but may be used by others). |