Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
View | Details | Raw Unified | Return to bug 143801
Collapse All | Expand All

(-)piklab-0.15.4/man/Makefile.am (-1 / +1 lines)
Lines 1-3 Link Here
1
man_MANS = piklab.1x piklab-prog.1 piklab-hex.1
1
man_MANS = piklab.1x piklab-prog.1 piklab-hex.1 piklab-coff.1
2
2
3
EXTRA_DIST = $(man_MANS)
3
EXTRA_DIST = $(man_MANS)
(-)piklab-0.15.4/man/Makefile.in (-5 / +5 lines)
Lines 1-5 Link Here
1
# Makefile.in generated by automake 1.10 from Makefile.am.
1
# Makefile.in generated by automake 1.10 from Makefile.am.
2
# KDE tags expanded automatically by am_edit - $Revision: 877 $ 
2
# KDE tags expanded automatically by am_edit - $Revision: 877 $
3
# @configure_input@
3
# @configure_input@
4
4
5
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
5
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
Lines 298-304 Link Here
298
xdg_appsdir = @xdg_appsdir@
298
xdg_appsdir = @xdg_appsdir@
299
xdg_directorydir = @xdg_directorydir@
299
xdg_directorydir = @xdg_directorydir@
300
xdg_menudir = @xdg_menudir@
300
xdg_menudir = @xdg_menudir@
301
man_MANS = piklab.1x piklab-prog.1 piklab-hex.1
301
man_MANS = piklab.1x piklab-prog.1 piklab-hex.1 piklab-coff.1
302
EXTRA_DIST = $(man_MANS)
302
EXTRA_DIST = $(man_MANS)
303
#>- all: all-am
303
#>- all: all-am
304
#>+ 1
304
#>+ 1
Lines 541-547 Link Here
541
.NOEXPORT:
541
.NOEXPORT:
542
542
543
#>+ 2
543
#>+ 2
544
KDE_DIST=Makefile.in piklab-prog.1 piklab.1x Makefile.am piklab-hex.1 
544
KDE_DIST=Makefile.in piklab-prog.1 piklab.1x Makefile.am piklab-hex.1 piklab-coff.1
545
545
546
#>+ 2
546
#>+ 2
547
docs-am:
547
docs-am:
Lines 563-569 Link Here
563
563
564
564
565
#>+ 21
565
#>+ 21
566
clean-bcheck: 
566
clean-bcheck:
567
	rm -f *.bchecktest.cc *.bchecktest.cc.class a.out
567
	rm -f *.bchecktest.cc *.bchecktest.cc.class a.out
568
568
569
bcheck: bcheck-am
569
bcheck: bcheck-am
Lines 605-609 Link Here
605
	-rm -f *.rpo
605
	-rm -f *.rpo
606
606
607
#>+ 3
607
#>+ 3
608
nmcheck: 
608
nmcheck:
609
nmcheck-am: nmcheck
609
nmcheck-am: nmcheck
(-)piklab-0.15.4/man/piklab.1x (-37 / +41 lines)
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-28 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 
17
.TH "PIKLAB" "1" "April 11, 2007" "" ""
19
\- IDE for PIC-microcontroller development.
18
.SH "NAME"
20
.TP
19
piklab \- IDE for PIC\-microcontroller development.
21
.SH SYNOPSIS
22
20
23
.B piklab [Qt-options] [KDE-options] [file]
21
.SH "SYNOPSIS"
22
.B piklab [Qt\-options] [KDE\-options] [file]
24
23
25
.br
24
.SH "DESCRIPTION"
26
.\" 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
27
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
26
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
28
.\" respectively.
27
.\" respectively.
Lines 30-82 Link Here
30
similar to the MPLAB environment. It integrates with several compiler and assembler toolchains (like gputils, sdcc, c18) and with the
29
similar to the MPLAB environment. It integrates with several compiler and assembler toolchains (like gputils, sdcc, c18) and with the
31
simulator gpsim. It supports the most common programmers (serial, parallel, ICD2, Pickit2, PicStart+) and debuggers (ICD2).
30
simulator gpsim. It supports the most common programmers (serial, parallel, ICD2, Pickit2, PicStart+) and debuggers (ICD2).
32
31
33
.TP
32
.SH "OPTIONS"
34
.SH OPTIONS
33
This program follows the usual GNU command line syntax, with long
35
These programs follow the usual GNU command line syntax, with long
34
options starting with two dashes ('\-').
36
options starting with two dashes (`-').
37
A summary of options is included below.
35
A summary of options is included below.
38
.TP
36
.TP
37
.B GENERIC OPTIONS:
38
.TP
39
.B \-h, \-\-help
39
.B \-h, \-\-help
40
Show summary of options.
40
Show summary of options.
41
.TP
41
.TP
42
.B \-v, \-\-version
42
.B \-\-help\-qt
43
Show version of program.
43
Show Qt specific options.
44
.TP
45
.B \-\-help-qt
46
	Show Qt specific options
47
.TP
44
.TP
48
.B \-\-help-kde
45
.B \-\-help\-kde
49
	Show KDE specific options
46
Show KDE specific options.
50
.TP
47
.TP
51
.B \-\-help-all
48
.B \-\-help\-all
52
	Show all options
49
Show all options.
53
.TP
50
.TP
54
.B \-\-author
51
.B \-\-author
55
	Show author information
52
Show author information.
53
.TP
54
.B \-v, \-\-version
55
Show version information.
56
.TP
56
.TP
57
.B \-\-license
57
.B \-\-license
58
	Show license information
58
Show license information.
59
.TP
59
.TP
60
.B \-\-
60
.B \-\-
61
	End of options
61
End of options.
62
.TP
62
63
.br
63
.br
64
.sp 3
64
.TP
65
.SH SEE ALSO
65
.B ARGUMENTS:
66
.BR piklab-prog (1),
66
.TP
67
.BR piklab-hex (1),
67
.B file
68
Optional filename(s) to be opened upon startup.
69
70
.SH "SEE ALSO"
71
.BR piklab\-prog (1),
72
.BR piklab\-hex (1),
73
.BR piklab\-coff (1),
68
.BR gputils (1),
74
.BR gputils (1),
69
.BR sdcc (1).
75
.BR sdcc (1).
70
.br
71
.SH AUTHORS
72
piklab was written by Nicolas Hadacek and many others, including:
73
76
77
.SH "AUTHORS"
78
Piklab was written by Nicolas Hadacek and many others, including:
74
    * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration.
79
    * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration.
75
    * Keith Baker: direct programmer support for 16F7X devices.
80
    * Keith Baker: direct programmer support for 16F7X devices.
76
    * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers.
81
    * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers.
77
    * Craig Franklin: author of gputils (disassembler and coff parser).
82
    * Craig Franklin: author of gputils (disassembler and coff parser).
78
    * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices.
83
    * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices.
79
    * Stephen Landamore: author of LPLAB (microchip command-line programmer).
84
    * Stephen Landamore: author of LPLAB (microchip command\-line programmer).
80
    * Brian C. Lane: original code for direct programming.
85
    * Brian C. Lane: original code for direct programming.
81
    * Sébastion Laoût: author of Likeback.
86
    * Sébastion Laoût: author of Likeback.
82
    * Nestor A. Marchesini: tests of PicStart+ programmer.
87
    * Nestor A. Marchesini: tests of PicStart+ programmer.
Lines 89-99 Link Here
89
    * Alain Portal: French translation.
94
    * Alain Portal: French translation.
90
    * Stefan von Halenbach: German translation.
95
    * Stefan von Halenbach: German translation.
91
    * Nagy Lázló: Hungarian translation.
96
    * Nagy Lázló: Hungarian translation.
92
.sp 3
93
.SH COPYRIGHT
94
	This  is  free  software.   You  may  redistribute  copies  of  it  under  the  terms   of   the   GNU   General   Public   License
95
       	<http://www.gnu.org/licenses/gpl.html>.  There is NO WARRANTY, to the extent permitted by law.
96
97
98
.SH "COPYRIGHT"
99
This is free software. You may redistribute copies of it under the terms of the GNU General Public License
100
<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.
97
.PP
101
.PP
98
This manual page was written by Stefan <vonHalenbach@users.sf.net>,
102
This manual page was written by Stefan <vonHalenbach@users.sf.net>,
99
for the Debian project (but may be used by others).
103
for the Debian project (but may be used by others).
(-)piklab-0.15.4/man/piklab-coff.1 (+155 lines)
Line 0 Link Here
1
.\" Hey, EMACS: -*- nroff -*-
2
.\" First parameter, NAME, should be all caps
3
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4
.\" other parameters are allowed: see man(7), man(1)
5
.\" Please adjust this date whenever revising the manpage.
6
.\"
7
.\" Some roff macros, for reference:
8
.\" .nh        disable hyphenation
9
.\" .hy        enable hyphenation
10
.\" .ad l      left justify
11
.\" .ad b      justify to both left and right margins
12
.\" .nf        disable filling
13
.\" .fi        enable filling
14
.\" .br        insert line break
15
.\" .sp <n>    insert n+1 empty lines
16
.\" for manpage-specific macros, see man(7)
17
.TH "PIKLAB" "1" "January 25, 2008" "" ""
18
.SH "NAME"
19
piklab\-coff \- Command\-line utility to view COFF files.
20
21
.SH "SYNOPSIS"
22
.B piklab\-coff [Qt\-options] [KDE\-options] [options] [file]
23
24
.SH "DESCRIPTION"
25
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
26
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
27
.\" respectively.
28
\fBPiklab\-coff\fP is a command line tool to view COFF files.
29
30
.SH "OPTIONS"
31
This program follows the usual GNU command line syntax, with long
32
options starting with two dashes ('\-').
33
A summary of options is included below.
34
.TP
35
.B GENERIC OPTIONS:
36
.TP
37
.B \-h, \-\-help
38
Show summary of options.
39
.TP
40
.B \-\-help\-qt
41
Show Qt specific options.
42
.TP
43
.B \-\-help\-kde
44
Show KDE specific options.
45
.TP
46
.B \-\-help\-all
47
Show all options.
48
.TP
49
.B \-\-author
50
Show author information.
51
.TP
52
.B \-v, \-\-version
53
Show version information.
54
.TP
55
.B \-\-license
56
Show license information.
57
.TP
58
.B \-\-
59
End of options.
60
61
.br
62
.TP
63
.B SPECIFIC OPTIONS:
64
.TP
65
.B \-c, \-\-command <name>
66
Perform the requested command.
67
.TP
68
.B \-\-command\-list
69
Return the list of recognized commands.
70
.TP
71
.B \-\-debug
72
Display debug messages.
73
.TP
74
.B \-\-extra\-debug
75
Display extra debug messages.
76
.TP
77
.B \-\-max\-debug
78
Display all debug messages.
79
.TP
80
.B \-\-lowlevel\-debug
81
Display low level debug messages.
82
.TP
83
.B \-\-quiet
84
Do not display messages.
85
.TP
86
.B \-f, \-\-force
87
Overwrite files and answer "yes" to questions.
88
.TP
89
.B \-d, \-\-device <name>
90
Target device.
91
.TP
92
.B \-\-device\-list
93
Return the list of supported devices.
94
95
.br
96
.TP
97
.B SUPPORTED COMMANDS:
98
.TP
99
.B info
100
Return general informations.
101
.TP
102
.B variables
103
Return informations about variables (for object).
104
.TP
105
.B symbols
106
Return informations about symbols.
107
.TP
108
.B sections
109
Return informations about sections (for object).
110
.TP
111
.B lines
112
Return informations about code lines (for object).
113
.TP
114
.B files
115
Return informations about files.
116
117
.br
118
.TP
119
.B ARGUMENTS:
120
.TP
121
.B file
122
COFF filename.
123
124
.SH "SEE ALSO"
125
.BR piklab (1),
126
.BR piklab\-prog (1),
127
.BR piklab\-hex (1).
128
129
.SH "AUTHORS"
130
Piklab was written by Nicolas Hadacek and many others, including:
131
    * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration.
132
    * Keith Baker: direct programmer support for 16F7X devices.
133
    * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers.
134
    * Craig Franklin: author of gputils (disassembler and coff parser).
135
    * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices.
136
    * Stephen Landamore: author of LPLAB (microchip command\-line programmer).
137
    * Brian C. Lane: original code for direct programming.
138
    * Sébastion Laoût: author of Likeback.
139
    * Nestor A. Marchesini: tests of PicStart+ programmer.
140
    * Lorenz Mösenlechner and Matthias Kranz: USB support for ICD2 programmer.
141
    * Mirko Panciri: direct programmers with bidirectionnal buffers.
142
    * Sean A. Walberg: direct programmer support for 16F676/630 devices.
143
144
.B Translations:
145
    * Michele Petrecca: Italian translation.
146
    * Alain Portal: French translation.
147
    * Stefan von Halenbach: German translation.
148
    * Nagy Lázló: Hungarian translation.
149
150
.SH "COPYRIGHT"
151
This is free software. You may redistribute copies of it under the terms of the GNU General Public License
152
<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.
153
.PP
154
This manual page was written by Miriam Ruiz <little_miry@yahoo.es>,
155
for the Debian project (but may be used by others).
(-)piklab-0.15.4/man/piklab-hex.1 (-36 / +101 lines)
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-79 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-HEX \- Tool to check INHEX-files.
17
.TH "PIKLAB" "1" "April 11, 2007" "" ""
19
.SH SYNOPSIS
18
.SH "NAME"
20
.B piklab-hex [options] [command] [file].hex
19
piklab\-hex \- Tool to check INHEX\-files.
21
.RI
22
20
23
.SH DESCRIPTION
21
.SH "SYNOPSIS"
24
22
.B piklab\-hex [Qt\-options] [KDE\-options] [options] [file]
25
This manual page documents briefly the
26
.B piklab-hex command.
27
23
24
.SH "DESCRIPTION"
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-hex\fP is a command line tool to check files, if they are valid Hex-files which comply with the INHEX-Standard defined by Intel corporation.
28
\fBPiklab\-hex\fP is a command line tool to check files, if they are valid Hex\-files which comply with the INHEX\-Standard defined by Intel corporation.
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
35
.B GENERIC OPTIONS:
36
.TP
38
.B \-h, \-\-help
37
.B \-h, \-\-help
39
	Show summary of options.
38
Show summary of options.
40
.TP
39
.TP
41
.B \-v, \-\-version
40
.B \-\-help\-qt
42
	Show version of program.
41
Show Qt specific options.
42
.TP
43
.B \-\-help\-kde
44
Show KDE specific options.
45
.TP
46
.B \-\-help\-all
47
Show all options.
43
.TP
48
.TP
44
.B \-\-author
49
.B \-\-author
45
	Show author information
50
Show author information.
51
.TP
52
.B \-v, \-\-version
53
Show version information.
46
.TP
54
.TP
47
.B \-\-license
55
.B \-\-license
48
	Show license information
56
Show license information.
57
.TP
58
.B \-\-
59
End of options.
60
61
.br
62
.TP
63
.B SPECIFIC OPTIONS:
64
.TP
65
.B \-c, \-\-command <name>
66
Perform the requested command.
67
.TP
68
.B \-\-command\-list
69
Return the list of recognized commands.
70
.TP
71
.B \-\-debug
72
Display debug messages.
73
.TP
74
.B \-\-extra\-debug
75
Display extra debug messages.
76
.TP
77
.B \-\-max\-debug
78
Display all debug messages.
49
.TP
79
.TP
50
.B \-c [command]
80
.B \-\-lowlevel\-debug
51
	Option to issue a command.
81
Display low level debug messages.
52
.TP
82
.TP
53
.SH COMMANDS
83
.B \-\-quiet
84
Do not display messages.
54
.TP
85
.TP
55
.B check		Check file, if it is a valid intel-hex-file.
86
.B \-f, \-\-force
87
Overwrite files and answer "yes" to questions.
56
.TP
88
.TP
57
.B info			Return information about hex file.
89
.B \-d, \-\-device <name>
90
Target device.
58
.TP
91
.TP
59
.B fix			Clean hex file and fix errors (wrong CRC, truncated line, truncated file).
92
.B \-\-device\-list
93
Return the list of supported devices.
60
.TP
94
.TP
61
.B compare		Compare two hex files.
95
.B \-\-fill <value>
96
Fill option.
62
.TP
97
.TP
98
.B \-\-fill\-list
99
Return the list of supported fill options.
100
63
.br
101
.br
64
.sp 3
102
.TP
65
.SH SEE ALSO
103
.B SUPPORTED COMMANDS:
66
.BR piklab (1),
104
.TP
67
.BR piklab-prog (1),
105
.B check
106
Check hex file for correctness (if a device is specified, check if hex file is compatible with it).
107
.TP
108
.B info
109
Return information about hex file.
110
.TP
111
.B fix
112
Clean hex file and fix errors (wrong CRC, truncated line, truncated file).
113
.TP
114
.B compare
115
Compare two hex files.
116
.TP
117
.B checksum
118
Return checksum.
119
.TP
120
.B create
121
Create an hex file for the specified device.
122
68
.br
123
.br
69
.SH AUTHORS
124
.TP
70
piklab was written by Nicolas Hadacek and many others, including:
125
.B ARGUMENTS:
126
.TP
127
.B file
128
HEX filename(s).
129
130
.SH "SEE ALSO"
131
.BR piklab (1),
132
.BR piklab\-prog (1),
133
.BR piklab\-coff (1).
134
135
.SH "AUTHORS"
136
Piklab was written by Nicolas Hadacek and many others, including:
71
    * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration.
137
    * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration.
72
    * Keith Baker: direct programmer support for 16F7X devices.
138
    * Keith Baker: direct programmer support for 16F7X devices.
73
    * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers.
139
    * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers.
74
    * Craig Franklin: author of gputils (disassembler and coff parser).
140
    * Craig Franklin: author of gputils (disassembler and coff parser).
75
    * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices.
141
    * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices.
76
    * Stephen Landamore: author of LPLAB (microchip command-line programmer).
142
    * Stephen Landamore: author of LPLAB (microchip command\-line programmer).
77
    * Brian C. Lane: original code for direct programming.
143
    * Brian C. Lane: original code for direct programming.
78
    * Sébastion Laoût: author of Likeback.
144
    * Sébastion Laoût: author of Likeback.
79
    * Nestor A. Marchesini: tests of PicStart+ programmer.
145
    * Nestor A. Marchesini: tests of PicStart+ programmer.
Lines 86-96 Link Here
86
    * Alain Portal: French translation.
152
    * Alain Portal: French translation.
87
    * Stefan von Halenbach: German translation.
153
    * Stefan von Halenbach: German translation.
88
    * Nagy Lázló: Hungarian translation.
154
    * Nagy Lázló: Hungarian translation.
89
.sp 3
90
.SH COPYRIGHT
91
	This  is  free  software.   You  may  redistribute  copies  of  it  under  the  terms   of   the   GNU   General   Public   License
92
       	<http://www.gnu.org/licenses/gpl.html>.  There is NO WARRANTY, to the extent permitted by law.
93
155
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.
94
.PP
159
.PP
95
This manual page was written by Stefan <vonHalenbach@users.sf.net>,
160
This manual page was written by Stefan <vonHalenbach@users.sf.net>,
96
for the Debian project (but may be used by others).
161
for the Debian project (but may be used by others).
(-)piklab-0.15.4/man/piklab-prog.1 (-75 / +116 lines)
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).

Return to bug 143801