summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorMichele Calgaro <michele.calgaro@yahoo.it>2024-04-11 11:35:29 +0900
committerMichele Calgaro <michele.calgaro@yahoo.it>2024-05-06 14:31:18 +0900
commite3e5eb5f859df0257827e18a9a5fd1268c6e467e (patch)
treee2a3c573b7060db047f13ed85aef570a22588290 /man
parented1e858c6dc1a08b3b498befdc4f6f313369a585 (diff)
downloadpiklab-e3e5eb5f859df0257827e18a9a5fd1268c6e467e.tar.gz
piklab-e3e5eb5f859df0257827e18a9a5fd1268c6e467e.zip
Update doc and man folder structure
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am3
-rw-r--r--man/piklab-coff.1129
-rw-r--r--man/piklab-hex.195
-rw-r--r--man/piklab-prog.1161
-rw-r--r--man/piklab.1x98
5 files changed, 0 insertions, 486 deletions
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 <n> 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<whatever>\fP and
-.\" \fI<whatever>\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 <name>
-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 <name>
-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
- <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.
-
-.PP
-This manual page was written by Miriam Ruiz <little_miry@yahoo.es>,
-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 <n> 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<whatever>\fP and
-.\" \fI<whatever>\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
- <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.
-
-.PP
-This manual page was written by Stefan <vonHalenbach@users.sf.net>,
-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 <n> 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<whatever>\fP and
-.\" \fI<whatever>\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 <name>
- 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 <name>
- Memory range to operate on.
-.TP
-.B \-\-range-list
- Return the list of memory ranges.
-.TP
-.B \-p, \-\-programmer <name>
- Programmer to use.
-.TP
-.B \-\-programmer-list
- Return the list of supported programmers.
-.TP
-.B \-d, \-\-device <name>
- Target device.
-.TP
-.B \-\-device-list
- Return the list of supported devices.
-.TP
-.B \-f, \-\-format <name>
- HEX output file format.
-.TP
-.B \-\-format-list
- Return the list of supported HEX file formats.
-.TP
-.B \-t, \-\-port <name>
- Programmer port ("usb" or device such as "/dev/ttyS0")
-.TP
-.B \-\-port-list
- Return the list of detected ports.
-.TP
-.B \-\-firmware-dir <dir>
- Firmware directory.
-.TP
-.B \-\-target-self-powered
- Indicates that device is self-powered.
-.br
-.SH Arguments:
-.B file <HEX-filename for programming>.
-.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
- <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.
-
-.PP
-This manual page was written by Stefan <vonHalenbach@users.sf.net>,
-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 <n> 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<whatever>\fP and
-.\" \fI<whatever>\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
- <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.
-
-.PP
-This manual page was written by Stefan <vonHalenbach@users.sf.net>,
-for the Debian project (but may be used by others).