From e3e5eb5f859df0257827e18a9a5fd1268c6e467e Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Thu, 11 Apr 2024 11:35:29 +0900 Subject: Update doc and man folder structure Signed-off-by: Michele Calgaro --- doc/Makefile.am | 4 +- doc/en/Makefile.am | 3 + doc/en/index.docbook | 56 ++++++++++++++++++ doc/index.docbook | 56 ------------------ doc/man/Makefile.am | 3 + doc/man/piklab-coff.1 | 129 ++++++++++++++++++++++++++++++++++++++++ doc/man/piklab-hex.1 | 95 +++++++++++++++++++++++++++++ doc/man/piklab-prog.1 | 161 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/man/piklab.1 | 98 ++++++++++++++++++++++++++++++ man/Makefile.am | 3 - man/piklab-coff.1 | 129 ---------------------------------------- man/piklab-hex.1 | 95 ----------------------------- man/piklab-prog.1 | 161 -------------------------------------------------- man/piklab.1x | 98 ------------------------------ subdirs | 1 - 15 files changed, 546 insertions(+), 546 deletions(-) create mode 100644 doc/en/Makefile.am create mode 100644 doc/en/index.docbook delete mode 100644 doc/index.docbook create mode 100644 doc/man/Makefile.am create mode 100644 doc/man/piklab-coff.1 create mode 100644 doc/man/piklab-hex.1 create mode 100644 doc/man/piklab-prog.1 create mode 100644 doc/man/piklab.1 delete mode 100644 man/Makefile.am delete mode 100644 man/piklab-coff.1 delete mode 100644 man/piklab-hex.1 delete mode 100644 man/piklab-prog.1 delete mode 100644 man/piklab.1x diff --git a/doc/Makefile.am b/doc/Makefile.am index 5eaf9b4..8bd0272 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,3 +1 @@ -KDE_LANG = en -KDE_DOCS = piklab - +SUBDIRS = en man diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..5eaf9b4 --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = piklab + diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..e8dc040 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,56 @@ + + + Piklab"> + + + +]> + + + + +The &piklab; Handbook + + + + +Nicolas +Hadacek + +hadacek@kde.org + + + + + + +2005 +Nicolas Hadacek + + + +2006-05-29 +0.1 + + + +&piklab; is an integrated development environment for applications based on Microchip PIC and +dsPIC microcontrollers similar to the MPLAB environment. Support for several compiler and +assembler toolchains is integrated. The ICD2 debugger, the PICkit1 and PICkit2 programmers, +and most direct programmers are supported. A command-line programmer "piklab-prog" is also available. + + + +Check &piklab; website for up-to-date information and help. + + + + +KDE + + + + + diff --git a/doc/index.docbook b/doc/index.docbook deleted file mode 100644 index e8dc040..0000000 --- a/doc/index.docbook +++ /dev/null @@ -1,56 +0,0 @@ - - - Piklab"> - - - -]> - - - - -The &piklab; Handbook - - - - -Nicolas -Hadacek - -hadacek@kde.org - - - - - - -2005 -Nicolas Hadacek - - - -2006-05-29 -0.1 - - - -&piklab; is an integrated development environment for applications based on Microchip PIC and -dsPIC microcontrollers similar to the MPLAB environment. Support for several compiler and -assembler toolchains is integrated. The ICD2 debugger, the PICkit1 and PICkit2 programmers, -and most direct programmers are supported. A command-line programmer "piklab-prog" is also available. - - - -Check &piklab; website for up-to-date information and help. - - - - -KDE - - - - - diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am new file mode 100644 index 0000000..bd8bee1 --- /dev/null +++ b/doc/man/Makefile.am @@ -0,0 +1,3 @@ +man_MANS = piklab.1 piklab-prog.1 piklab-hex.1 piklab-coff.1 + +EXTRA_DIST = $(man_MANS) diff --git a/doc/man/piklab-coff.1 b/doc/man/piklab-coff.1 new file mode 100644 index 0000000..42a7126 --- /dev/null +++ b/doc/man/piklab-coff.1 @@ -0,0 +1,129 @@ +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.TH "PIKLAB" "1" "January 25, 2008" "" "" +.SH "NAME" +piklab\-coff \- Command\-line utility to view COFF files. +.SH "SYNOPSIS" +.B piklab\-coff [TQt\-options] [KDE\-options] [options] [file] +.RI + +.SH "DESCRIPTION" +This manual page documents briefly the +.B piklab\-coff command. + +.\" TeX users may be more comfortable with the \fB\fP and +.\" \fI\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBPiklab\-coff\fP is a command line tool to view COFF files. + +.SH "OPTIONS" +These programs follow the usual GNU command line syntax, with long +options starting with two dashes (`\-'). +A summary of options is included below. + +Generic options: +.TP +.B \-h, \-\-help +Show summary of options. +.TP +.B \-v, \-\-version +Show version of program. +.TP +.B \-\-help\-tqt + Show TQt specific options +.TP +.B \-\-help\-kde + Show KDE specific options +.TP +.B \-\-help\-all + Show all options +.TP +.B \-\-author + Show author information +.TP +.B \-\-license + Show license information +.TP +.B \-\- + End of options +.TP +.br + +Options: +.TP +.B \-c, \-\-command +Perform the requested command. +.TP +.B \-\-command\-list +Return the list of recognized commands. +.TP +.B \-\-debug +Display debug messages. +.TP +.B \-\-extra\-debug +Display extra debug messages. +.TP +.B \-\-max\-debug +Display all debug messages. +.TP +.B \-\-lowlevel\-debug +Display low level debug messages. +.TP +.B \-\-quiet +Do not display messages. +.TP +.B \-f, \-\-force +Overwrite files and answer "yes" to questions. +.TP +.B \-d, \-\-device +Target device. +.TP +.B \-\-device\-list +Return the list of supported devices. +.sp 3 +.SH "SEE ALSO" +.BR piklab (1), +.BR piklab\-prog (1), +.BR piklab\-hex (1). +.br +.SH "AUTHORS" +piklab was written by Nicolas Hadacek and many others, including: + * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. + * Keith Baker: direct programmer support for 16F7X devices. + * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. + * Craig Franklin: author of gputils (disassembler and coff parser). + * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. + * Stephen Landamore: author of LPLAB (microchip command\-line programmer). + * Brian C. Lane: original code for direct programming. + * Sébastion Laoût: author of Likeback. + * Nestor A. Marchesini: tests of PicStart+ programmer. + * Lorenz Mösenlechner and Matthias Kranz: USB support for ICD2 programmer. + * Mirko Panciri: direct programmers with bidirectionnal buffers. + * Sean A. Walberg: direct programmer support for 16F676/630 devices. + +.B Translations: + * Michele Petrecca: Italian translation. + * Alain Portal: French translation. + * Stefan von Halenbach: German translation. + * Nagy Lázló: Hungarian translation. +.sp 3 +.SH "COPYRIGHT" +This is free software. You may redistribute copies of it under the terms of the GNU General Public License + . There is NO WARRANTY, to the extent permitted by law. + +.PP +This manual page was written by Miriam Ruiz , +for the Debian project (but may be used by others). diff --git a/doc/man/piklab-hex.1 b/doc/man/piklab-hex.1 new file mode 100644 index 0000000..bd19848 --- /dev/null +++ b/doc/man/piklab-hex.1 @@ -0,0 +1,95 @@ +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH PIKLAB SECTION "April 11, 2007" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH PIKLAB-HEX \- Tool to check INHEX-files. +.SH SYNOPSIS +.B piklab-hex [options] [command] [file].hex +.RI + +.SH DESCRIPTION + +This manual page documents briefly the +.B piklab-hex command. + +.\" TeX users may be more comfortable with the \fB\fP and +.\" \fI\fP escape sequences to invode bold face and italics, +.\" respectively. +\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. + +.SH OPTIONS +This program follows the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +.TP +.B \-h, \-\-help + Show summary of options. +.TP +.B \-v, \-\-version + Show version of program. +.TP +.B \-\-author + Show author information +.TP +.B \-\-license + Show license information +.TP +.B \-c [command] + Option to issue a command. +.TP +.SH COMMANDS +.TP +.B check Check file, if it is a valid intel-hex-file. +.TP +.B info Return information about hex file. +.TP +.B fix Clean hex file and fix errors (wrong CRC, truncated line, truncated file). +.TP +.B compare Compare two hex files. +.TP +.br +.sp 3 +.SH SEE ALSO +.BR piklab (1), +.BR piklab-prog (1), +.br +.SH AUTHORS +piklab was written by Nicolas Hadacek and many others, including: + * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. + * Keith Baker: direct programmer support for 16F7X devices. + * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. + * Craig Franklin: author of gputils (disassembler and coff parser). + * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. + * Stephen Landamore: author of LPLAB (microchip command-line programmer). + * Brian C. Lane: original code for direct programming. + * Sébastion Laoût: author of Likeback. + * Nestor A. Marchesini: tests of PicStart+ programmer. + * Lorenz Mösenlechner and Matthias Kranz: USB support for ICD2 programmer. + * Mirko Panciri: direct programmers with bidirectionnal buffers. + * Sean A. Walberg: direct programmer support for 16F676/630 devices. + +.B Translations: + * Michele Petrecca: Italian translation. + * Alain Portal: French translation. + * Stefan von Halenbach: German translation. + * Nagy Lázló: Hungarian translation. +.sp 3 +.SH COPYRIGHT + This is free software. You may redistribute copies of it under the terms of the GNU General Public License + . There is NO WARRANTY, to the extent permitted by law. + +.PP +This manual page was written by Stefan , +for the Debian project (but may be used by others). diff --git a/doc/man/piklab-prog.1 b/doc/man/piklab-prog.1 new file mode 100644 index 0000000..e0d6340 --- /dev/null +++ b/doc/man/piklab-prog.1 @@ -0,0 +1,161 @@ +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH PIKLAB SECTION "April 11, 2007" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH PIKLAB-PROG \- Commandline program for PIC-microcontroller programming. +.SH SYNOPSIS +.B piklab-prog [TQt-options] [KDE-options] [options] [file] +.RI + +.br +.SH DESCRIPTION +This manual page documents briefly the +.B piklab-prog command. +.PP +.\" TeX users may be more comfortable with the \fB\fP and +.\" \fI\fP escape sequences to invode bold face and italics, +.\" respectively. +\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). + +.SH OPTIONS +This program follows the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +.TP +.B \-h, \-\-help + Show summary of options. +.TP +.B \-v, \-\-version + Show version of program. +.TP +.B \-\-help-tqt + Show TQt specific options +.TP +.B \-\-help-kde + Show KDE specific options +.TP +.B \-\-help-all + Show all options +.TP +.B \-\-author + Show author information +.TP +.B \-\-license + Show license information +.TP +.B \-\- + End of options +.br +.B Options: +.B \-c, \-\-command + Perform the requested command. +.TP +.B \-\-command-list + Return the list of recognized commands. +.TP +.B \-\-debug + Display debug messages. +.TP +.B \-\-extra-debug + Display extra debug messages. +.TP +.B \-\-max-debug + Display all debug messages. +.TP +.B \-\-quiet + Do not display messages. +.TP +.B \-f, \-\-force + Overwrite files and answer "yes" to questions. +.TP +.B \-i, \-\-cli + Interactive mode +.TP +.B \-r, \-\-range + Memory range to operate on. +.TP +.B \-\-range-list + Return the list of memory ranges. +.TP +.B \-p, \-\-programmer + Programmer to use. +.TP +.B \-\-programmer-list + Return the list of supported programmers. +.TP +.B \-d, \-\-device + Target device. +.TP +.B \-\-device-list + Return the list of supported devices. +.TP +.B \-f, \-\-format + HEX output file format. +.TP +.B \-\-format-list + Return the list of supported HEX file formats. +.TP +.B \-t, \-\-port + Programmer port ("usb" or device such as "/dev/ttyS0") +.TP +.B \-\-port-list + Return the list of detected ports. +.TP +.B \-\-firmware-dir + Firmware directory. +.TP +.B \-\-target-self-powered + Indicates that device is self-powered. +.br +.SH Arguments: +.B file . +.br +.sp 2 +.SH SEE ALSO +.BR piklab-prog (1), +.BR piklab-hex (1), +.BR gputils (1), +.BR sdcc (1). +.br +.SH AUTHORS +piklab was written by Nicolas Hadacek and many others, including: + + * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. + + * Keith Baker: direct programmer support for 16F7X devices. + * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. + * Craig Franklin: author of gputils (disassembler and coff parser). + * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. + * Stephen Landamore: author of LPLAB (microchip command-line programmer). + * Brian C. Lane: original code for direct programming. + * Sébastion Laoût: author of Likeback. + * Nestor A. Marchesini: tests of PicStart+ programmer. + * Lorenz Mösenlechner and Matthias Kranz: USB support for ICD2 programmer. + * Mirko Panciri: direct programmers with bidirectionnal buffers. + * Sean A. Walberg: direct programmer support for 16F676/630 devices. + +.B Translations: + * Michele Petrecca: Italian translation. + * Alain Portal: French translation. + * Stefan von Halenbach: German translation. + * Nagy Lázló: Hungarian translation. +.sp 2 +.SH COPYRIGHT + This is free software. You may redistribute copies of it under the terms of the GNU General Public License + . There is NO WARRANTY, to the extent permitted by law. + +.PP +This manual page was written by Stefan , +for the Debian project (but may be used by others). diff --git a/doc/man/piklab.1 b/doc/man/piklab.1 new file mode 100644 index 0000000..65d9e2c --- /dev/null +++ b/doc/man/piklab.1 @@ -0,0 +1,98 @@ +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH PIKLAB SECTION "April 11, 2007" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH PIKLAB +\- IDE for PIC-microcontroller development. +.TP +.SH SYNOPSIS + +.B piklab [TQt-options] [KDE-options] [file] + +.br +.\" TeX users may be more comfortable with the \fB\fP and +.\" \fI\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBPiklab\fP is an integrated development environment for applications based on Microchip PIC and dsPIC microcontrollers +similar to the MPLAB environment. It integrates with several compiler and assembler toolchains (like gputils, sdcc, c18) and with the +simulator gpsim. It supports the most common programmers (serial, parallel, ICD2, Pickit2, PicStart+) and debuggers (ICD2). + +.TP +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes (`-'). +A summary of options is included below. +.TP +.B \-h, \-\-help +Show summary of options. +.TP +.B \-v, \-\-version +Show version of program. +.TP +.B \-\-help-tqt + Show TQt specific options +.TP +.B \-\-help-kde + Show KDE specific options +.TP +.B \-\-help-all + Show all options +.TP +.B \-\-author + Show author information +.TP +.B \-\-license + Show license information +.TP +.B \-\- + End of options +.TP +.br +.sp 3 +.SH SEE ALSO +.BR piklab-prog (1), +.BR piklab-hex (1), +.BR gputils (1), +.BR sdcc (1). +.br +.SH AUTHORS +piklab was written by Nicolas Hadacek and many others, including: + + * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. + * Keith Baker: direct programmer support for 16F7X devices. + * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. + * Craig Franklin: author of gputils (disassembler and coff parser). + * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. + * Stephen Landamore: author of LPLAB (microchip command-line programmer). + * Brian C. Lane: original code for direct programming. + * Sébastion Laoût: author of Likeback. + * Nestor A. Marchesini: tests of PicStart+ programmer. + * Lorenz Mösenlechner and Matthias Kranz: USB support for ICD2 programmer. + * Mirko Panciri: direct programmers with bidirectionnal buffers. + * Sean A. Walberg: direct programmer support for 16F676/630 devices. + +.B Translations: + * Michele Petrecca: Italian translation. + * Alain Portal: French translation. + * Stefan von Halenbach: German translation. + * Nagy Lázló: Hungarian translation. +.sp 3 +.SH COPYRIGHT + This is free software. You may redistribute copies of it under the terms of the GNU General Public License + . There is NO WARRANTY, to the extent permitted by law. + +.PP +This manual page was written by Stefan , +for the Debian project (but may be used by others). diff --git a/man/Makefile.am b/man/Makefile.am deleted file mode 100644 index d95deac..0000000 --- a/man/Makefile.am +++ /dev/null @@ -1,3 +0,0 @@ -man_MANS = piklab.1x piklab-prog.1 piklab-hex.1 piklab-coff.1 - -EXTRA_DIST = $(man_MANS) diff --git a/man/piklab-coff.1 b/man/piklab-coff.1 deleted file mode 100644 index 42a7126..0000000 --- a/man/piklab-coff.1 +++ /dev/null @@ -1,129 +0,0 @@ -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for manpage-specific macros, see man(7) -.TH "PIKLAB" "1" "January 25, 2008" "" "" -.SH "NAME" -piklab\-coff \- Command\-line utility to view COFF files. -.SH "SYNOPSIS" -.B piklab\-coff [TQt\-options] [KDE\-options] [options] [file] -.RI - -.SH "DESCRIPTION" -This manual page documents briefly the -.B piklab\-coff command. - -.\" TeX users may be more comfortable with the \fB\fP and -.\" \fI\fP escape sequences to invode bold face and italics, -.\" respectively. -\fBPiklab\-coff\fP is a command line tool to view COFF files. - -.SH "OPTIONS" -These programs follow the usual GNU command line syntax, with long -options starting with two dashes (`\-'). -A summary of options is included below. - -Generic options: -.TP -.B \-h, \-\-help -Show summary of options. -.TP -.B \-v, \-\-version -Show version of program. -.TP -.B \-\-help\-tqt - Show TQt specific options -.TP -.B \-\-help\-kde - Show KDE specific options -.TP -.B \-\-help\-all - Show all options -.TP -.B \-\-author - Show author information -.TP -.B \-\-license - Show license information -.TP -.B \-\- - End of options -.TP -.br - -Options: -.TP -.B \-c, \-\-command -Perform the requested command. -.TP -.B \-\-command\-list -Return the list of recognized commands. -.TP -.B \-\-debug -Display debug messages. -.TP -.B \-\-extra\-debug -Display extra debug messages. -.TP -.B \-\-max\-debug -Display all debug messages. -.TP -.B \-\-lowlevel\-debug -Display low level debug messages. -.TP -.B \-\-quiet -Do not display messages. -.TP -.B \-f, \-\-force -Overwrite files and answer "yes" to questions. -.TP -.B \-d, \-\-device -Target device. -.TP -.B \-\-device\-list -Return the list of supported devices. -.sp 3 -.SH "SEE ALSO" -.BR piklab (1), -.BR piklab\-prog (1), -.BR piklab\-hex (1). -.br -.SH "AUTHORS" -piklab was written by Nicolas Hadacek and many others, including: - * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. - * Keith Baker: direct programmer support for 16F7X devices. - * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. - * Craig Franklin: author of gputils (disassembler and coff parser). - * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. - * Stephen Landamore: author of LPLAB (microchip command\-line programmer). - * Brian C. Lane: original code for direct programming. - * Sébastion Laoût: author of Likeback. - * Nestor A. Marchesini: tests of PicStart+ programmer. - * Lorenz Mösenlechner and Matthias Kranz: USB support for ICD2 programmer. - * Mirko Panciri: direct programmers with bidirectionnal buffers. - * Sean A. Walberg: direct programmer support for 16F676/630 devices. - -.B Translations: - * Michele Petrecca: Italian translation. - * Alain Portal: French translation. - * Stefan von Halenbach: German translation. - * Nagy Lázló: Hungarian translation. -.sp 3 -.SH "COPYRIGHT" -This is free software. You may redistribute copies of it under the terms of the GNU General Public License - . There is NO WARRANTY, to the extent permitted by law. - -.PP -This manual page was written by Miriam Ruiz , -for the Debian project (but may be used by others). diff --git a/man/piklab-hex.1 b/man/piklab-hex.1 deleted file mode 100644 index bd19848..0000000 --- a/man/piklab-hex.1 +++ /dev/null @@ -1,95 +0,0 @@ -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH PIKLAB SECTION "April 11, 2007" -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for manpage-specific macros, see man(7) -.SH PIKLAB-HEX \- Tool to check INHEX-files. -.SH SYNOPSIS -.B piklab-hex [options] [command] [file].hex -.RI - -.SH DESCRIPTION - -This manual page documents briefly the -.B piklab-hex command. - -.\" TeX users may be more comfortable with the \fB\fP and -.\" \fI\fP escape sequences to invode bold face and italics, -.\" respectively. -\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. - -.SH OPTIONS -This program follows the usual GNU command line syntax, with long -options starting with two dashes (`-'). -A summary of options is included below. -.TP -.B \-h, \-\-help - Show summary of options. -.TP -.B \-v, \-\-version - Show version of program. -.TP -.B \-\-author - Show author information -.TP -.B \-\-license - Show license information -.TP -.B \-c [command] - Option to issue a command. -.TP -.SH COMMANDS -.TP -.B check Check file, if it is a valid intel-hex-file. -.TP -.B info Return information about hex file. -.TP -.B fix Clean hex file and fix errors (wrong CRC, truncated line, truncated file). -.TP -.B compare Compare two hex files. -.TP -.br -.sp 3 -.SH SEE ALSO -.BR piklab (1), -.BR piklab-prog (1), -.br -.SH AUTHORS -piklab was written by Nicolas Hadacek and many others, including: - * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. - * Keith Baker: direct programmer support for 16F7X devices. - * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. - * Craig Franklin: author of gputils (disassembler and coff parser). - * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. - * Stephen Landamore: author of LPLAB (microchip command-line programmer). - * Brian C. Lane: original code for direct programming. - * Sébastion Laoût: author of Likeback. - * Nestor A. Marchesini: tests of PicStart+ programmer. - * Lorenz Mösenlechner and Matthias Kranz: USB support for ICD2 programmer. - * Mirko Panciri: direct programmers with bidirectionnal buffers. - * Sean A. Walberg: direct programmer support for 16F676/630 devices. - -.B Translations: - * Michele Petrecca: Italian translation. - * Alain Portal: French translation. - * Stefan von Halenbach: German translation. - * Nagy Lázló: Hungarian translation. -.sp 3 -.SH COPYRIGHT - This is free software. You may redistribute copies of it under the terms of the GNU General Public License - . There is NO WARRANTY, to the extent permitted by law. - -.PP -This manual page was written by Stefan , -for the Debian project (but may be used by others). diff --git a/man/piklab-prog.1 b/man/piklab-prog.1 deleted file mode 100644 index e0d6340..0000000 --- a/man/piklab-prog.1 +++ /dev/null @@ -1,161 +0,0 @@ -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH PIKLAB SECTION "April 11, 2007" -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for manpage-specific macros, see man(7) -.SH PIKLAB-PROG \- Commandline program for PIC-microcontroller programming. -.SH SYNOPSIS -.B piklab-prog [TQt-options] [KDE-options] [options] [file] -.RI - -.br -.SH DESCRIPTION -This manual page documents briefly the -.B piklab-prog command. -.PP -.\" TeX users may be more comfortable with the \fB\fP and -.\" \fI\fP escape sequences to invode bold face and italics, -.\" respectively. -\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). - -.SH OPTIONS -This program follows the usual GNU command line syntax, with long -options starting with two dashes (`-'). -A summary of options is included below. -.TP -.B \-h, \-\-help - Show summary of options. -.TP -.B \-v, \-\-version - Show version of program. -.TP -.B \-\-help-tqt - Show TQt specific options -.TP -.B \-\-help-kde - Show KDE specific options -.TP -.B \-\-help-all - Show all options -.TP -.B \-\-author - Show author information -.TP -.B \-\-license - Show license information -.TP -.B \-\- - End of options -.br -.B Options: -.B \-c, \-\-command - Perform the requested command. -.TP -.B \-\-command-list - Return the list of recognized commands. -.TP -.B \-\-debug - Display debug messages. -.TP -.B \-\-extra-debug - Display extra debug messages. -.TP -.B \-\-max-debug - Display all debug messages. -.TP -.B \-\-quiet - Do not display messages. -.TP -.B \-f, \-\-force - Overwrite files and answer "yes" to questions. -.TP -.B \-i, \-\-cli - Interactive mode -.TP -.B \-r, \-\-range - Memory range to operate on. -.TP -.B \-\-range-list - Return the list of memory ranges. -.TP -.B \-p, \-\-programmer - Programmer to use. -.TP -.B \-\-programmer-list - Return the list of supported programmers. -.TP -.B \-d, \-\-device - Target device. -.TP -.B \-\-device-list - Return the list of supported devices. -.TP -.B \-f, \-\-format - HEX output file format. -.TP -.B \-\-format-list - Return the list of supported HEX file formats. -.TP -.B \-t, \-\-port - Programmer port ("usb" or device such as "/dev/ttyS0") -.TP -.B \-\-port-list - Return the list of detected ports. -.TP -.B \-\-firmware-dir - Firmware directory. -.TP -.B \-\-target-self-powered - Indicates that device is self-powered. -.br -.SH Arguments: -.B file . -.br -.sp 2 -.SH SEE ALSO -.BR piklab-prog (1), -.BR piklab-hex (1), -.BR gputils (1), -.BR sdcc (1). -.br -.SH AUTHORS -piklab was written by Nicolas Hadacek and many others, including: - - * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. - - * Keith Baker: direct programmer support for 16F7X devices. - * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. - * Craig Franklin: author of gputils (disassembler and coff parser). - * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. - * Stephen Landamore: author of LPLAB (microchip command-line programmer). - * Brian C. Lane: original code for direct programming. - * Sébastion Laoût: author of Likeback. - * Nestor A. Marchesini: tests of PicStart+ programmer. - * Lorenz Mösenlechner and Matthias Kranz: USB support for ICD2 programmer. - * Mirko Panciri: direct programmers with bidirectionnal buffers. - * Sean A. Walberg: direct programmer support for 16F676/630 devices. - -.B Translations: - * Michele Petrecca: Italian translation. - * Alain Portal: French translation. - * Stefan von Halenbach: German translation. - * Nagy Lázló: Hungarian translation. -.sp 2 -.SH COPYRIGHT - This is free software. You may redistribute copies of it under the terms of the GNU General Public License - . There is NO WARRANTY, to the extent permitted by law. - -.PP -This manual page was written by Stefan , -for the Debian project (but may be used by others). diff --git a/man/piklab.1x b/man/piklab.1x deleted file mode 100644 index 65d9e2c..0000000 --- a/man/piklab.1x +++ /dev/null @@ -1,98 +0,0 @@ -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH PIKLAB SECTION "April 11, 2007" -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for manpage-specific macros, see man(7) -.SH PIKLAB -\- IDE for PIC-microcontroller development. -.TP -.SH SYNOPSIS - -.B piklab [TQt-options] [KDE-options] [file] - -.br -.\" TeX users may be more comfortable with the \fB\fP and -.\" \fI\fP escape sequences to invode bold face and italics, -.\" respectively. -\fBPiklab\fP is an integrated development environment for applications based on Microchip PIC and dsPIC microcontrollers -similar to the MPLAB environment. It integrates with several compiler and assembler toolchains (like gputils, sdcc, c18) and with the -simulator gpsim. It supports the most common programmers (serial, parallel, ICD2, Pickit2, PicStart+) and debuggers (ICD2). - -.TP -.SH OPTIONS -These programs follow the usual GNU command line syntax, with long -options starting with two dashes (`-'). -A summary of options is included below. -.TP -.B \-h, \-\-help -Show summary of options. -.TP -.B \-v, \-\-version -Show version of program. -.TP -.B \-\-help-tqt - Show TQt specific options -.TP -.B \-\-help-kde - Show KDE specific options -.TP -.B \-\-help-all - Show all options -.TP -.B \-\-author - Show author information -.TP -.B \-\-license - Show license information -.TP -.B \-\- - End of options -.TP -.br -.sp 3 -.SH SEE ALSO -.BR piklab-prog (1), -.BR piklab-hex (1), -.BR gputils (1), -.BR sdcc (1). -.br -.SH AUTHORS -piklab was written by Nicolas Hadacek and many others, including: - - * Alain Gibaud: author of Pikdev; main infrastructure; IDE interface; direct programmers; gputils integration. - * Keith Baker: direct programmer support for 16F7X devices. - * Xiaofan Chen: numerous tests of PICkit1/2 and ICD2 programmers. - * Craig Franklin: author of gputils (disassembler and coff parser). - * Manwlis Giannos: direct programmer support for PIC18FXX2/FXX8 devices. - * Stephen Landamore: author of LPLAB (microchip command-line programmer). - * Brian C. Lane: original code for direct programming. - * Sébastion Laoût: author of Likeback. - * Nestor A. Marchesini: tests of PicStart+ programmer. - * Lorenz Mösenlechner and Matthias Kranz: USB support for ICD2 programmer. - * Mirko Panciri: direct programmers with bidirectionnal buffers. - * Sean A. Walberg: direct programmer support for 16F676/630 devices. - -.B Translations: - * Michele Petrecca: Italian translation. - * Alain Portal: French translation. - * Stefan von Halenbach: German translation. - * Nagy Lázló: Hungarian translation. -.sp 3 -.SH COPYRIGHT - This is free software. You may redistribute copies of it under the terms of the GNU General Public License - . There is NO WARRANTY, to the extent permitted by law. - -.PP -This manual page was written by Stefan , -for the Debian project (but may be used by others). diff --git a/subdirs b/subdirs index b668b73..0e67810 100644 --- a/subdirs +++ b/subdirs @@ -1,4 +1,3 @@ doc -man po src -- cgit v1.2.1