From d59fda15d281e2107493970bc226c578d2f1e4ab Mon Sep 17 00:00:00 2001 From: Kolja Waschk Date: Sat, 15 Dec 2007 19:46:32 +0000 Subject: [PATCH] Updated manpages and ChangeLog git-svn-id: https://urjtag.svn.sourceforge.net/svnroot/urjtag/trunk@844 b68d4a1b-bc3d-0410-92ed-d4ac073336b7 --- jtag/doc/ChangeLog | 5 +- jtag/doc/UrJTAG.txt | 18 +++++ jtag/doc/bsdl2jtag.1 | 30 +++++--- jtag/doc/jtag.1 | 39 +++++++--- jtag/doc/lgpl.txt | 165 ------------------------------------------- 5 files changed, 69 insertions(+), 188 deletions(-) delete mode 100644 jtag/doc/lgpl.txt diff --git a/jtag/doc/ChangeLog b/jtag/doc/ChangeLog index b53e6d18..1cb8c394 100644 --- a/jtag/doc/ChangeLog +++ b/jtag/doc/ChangeLog @@ -1,8 +1,9 @@ 2007-12-15 Kolja Waschk - * lgpl.txt, gpl.txt, fdl.txt: licenses as plain text files + * fdl.txt, gpl.txt: licenses as plain text files + * lgpl.txt: Lesser GPL not in use (yet), removed * jtag.1, bsdl2jtag.1: manpages copied (with permission) from - Debian openwince jtag package. + Debian openwince jtag package, then updated for UrJTAG. * Makefile.am: add new files 2007-12-10 Arnim Laeuger diff --git a/jtag/doc/UrJTAG.txt b/jtag/doc/UrJTAG.txt index aad7a90a..d0607d3c 100644 --- a/jtag/doc/UrJTAG.txt +++ b/jtag/doc/UrJTAG.txt @@ -618,3 +618,21 @@ Q. During compilation, I get "src/svf/svf_flex.l", line 27: unrecognized %option //======================================================================== +== Licensing == + +=== Overview === + +Three licenses are used for the UrJTAG project. The GPL is used for most +of the code except for the files in the inclow/ subdirectory; the FDL is +used for this documentation. The files in the inclow/ subdirectory are +subject to different licensing as described in the file inclow/COPYING. + +=== GNU Free Documentation License (FDL) === +......................................... +include::fdl.txt[] +......................................... +=== GNU General Public License (GPL) === +......................................... +include::gpl.txt[] +......................................... + diff --git a/jtag/doc/bsdl2jtag.1 b/jtag/doc/bsdl2jtag.1 index 427d7044..6ca6d07c 100644 --- a/jtag/doc/bsdl2jtag.1 +++ b/jtag/doc/bsdl2jtag.1 @@ -1,23 +1,33 @@ .\" Process this file with .\" groff -man -Tascii foo.1 .\" -.TH jtag 1 "OCTOBER 2003" Linux "User Manuals" +.TH bsdl2jtag 1 "DECEMBER 2007" UrJTAG "User Manuals" .SH NAME -jtag \- bsdl2jtag +bsdl2jtag \- UrJTAG declaration file conversion .SH SYNOPSIS -.B bsdl2jtag +.B bsdl2jtag +< +.I infile +> +.I outfile .SH DESCRIPTION -.B bsdl2jtag converts bsdl files to jtag files which can be used by B jtag. .B bsdl2jtag reads from stdin and produces its output on stdout. +.B bsdl2jtag +converts bsdl files to jtag files which can be used by +.BR jtag (1). +.B bsdl2jtag +reads from stdin and produces its output on stdout. .SH OPTIONS -none -.SH FILES -none +None. .SH BUGS -Lots -.SH AUTHOR -Marcel Telka +Bugs are tracked at the project homepage, http://www.urjtag.org .SH "SEE ALSO" .BR jtag (1) +.SH AUTHORS +Authors and contributors are listed in the AUTHORS and THANKS files in +the source documentation. +.SH HISTORY +JTAG Tools originally have been developed as part of the openwince project by +Marcel Telka. The became an independent project named UrJTAG in late 2007. diff --git a/jtag/doc/jtag.1 b/jtag/doc/jtag.1 index 7f043d57..6ab47a2b 100644 --- a/jtag/doc/jtag.1 +++ b/jtag/doc/jtag.1 @@ -1,29 +1,46 @@ .\" Process this file with .\" groff -man -Tascii foo.1 .\" -.TH jtag 1 "OCTOBER 2003" Linux "User Manuals" +.TH jtag 1 "DECEMBER 2007" UrJTAG "User Manuals" .SH NAME -jtag \- jtag manipulation tool +jtag \- UrJTAG command shell .SH SYNOPSIS .B jtag +[\-hnv] .I file .B ... .SH DESCRIPTION -JTAG Tools is a software package which enables working with JTAG-aware -(IEEE 1149.1) hardware devices (parts) and boards through JTAG adapter. - +UrJTAG is a software package which enables working with JTAG-aware (IEEE +1149.1) hardware devices (parts) and boards through JTAG adapter. .SH OPTIONS -none +.TP +.I \-h, \-\-help +Display a short help text and exit +.TP +.I \-n, \-\-norc +Disable reading ~/.jtag/rc on startup +.TP +.I \-v, \-\-version +Display version information and exit .SH FILES +.PP +.I ~/jtag/rc +.IP +A per-user text file containing jtag commands to execute at startup. +.PP .I /usr/share/jtag -.RS -Scripts for various controllers +.IP +Data files about various CPUs, flash chips etc. .SH BUGS -Lots -.SH AUTHOR -Marcel Telka +Bugs are tracked at the project homepage, http://www.urjtag.org .SH "SEE ALSO" .BR bsdl2jtag (1) +.SH AUTHORS +Authors and contributors are listed in the AUTHORS and THANKS files in +the source documentation. +.SH HISTORY +JTAG Tools originally have been developed as part of the openwince project by +Marcel Telka. The became an independent project named UrJTAG in late 2007. diff --git a/jtag/doc/lgpl.txt b/jtag/doc/lgpl.txt deleted file mode 100644 index fc8a5de7..00000000 --- a/jtag/doc/lgpl.txt +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library.