From 5aa1fae67acc9c5eda0efde49e0f6daa34c14ed3 Mon Sep 17 00:00:00 2001 From: Patrick Kloepfer Date: Sun, 14 Apr 2019 11:45:02 -0400 Subject: [PATCH] Updated all documentation files with new LICENSE and COPYRIGHT sections. Updated docgen.cmd tool so that it automatically adds proper Copyright and License and now includes an end *** End of Autogen File *** so that when viewing files you know you have everything. There is now a footer.txt file (where license txt comes from), we could add a header file if desired to place some more descriptive info at the top of all autogen files. --- .Docs/ASM.md | 18 +++++++++++++++++- .Docs/Command Guide.md | 15 +++++++++++++++ .Docs/Developers Guide.md | 15 +++++++++++++++ .Docs/KERNEL.md | 20 ++++++++++++++++++++ .Docs/LIBBLKDEV.md | 20 ++++++++++++++++++++ .Docs/LIBCRYPT.md | 20 ++++++++++++++++++++ .Docs/LIBGUI.md | 20 ++++++++++++++++++++ .Docs/LIBPAK.md | 20 ++++++++++++++++++++ .Docs/LIBTCPIP.md | 20 ++++++++++++++++++++ .Docs/Media Guide.md | 15 +++++++++++++++ .Docs/News.md | 14 ++++++++++++++ .Docs/Screen Shots.md | 15 +++++++++++++++ .Docs/Shell Developers Guide.md | 14 ++++++++++++++ .Docs/Technical Spec.md | 14 ++++++++++++++ .Docs/User Guide.md | 14 ++++++++++++++ .Tools/docgen.cmd | 11 +++++++---- .Tools/footer.txt | 15 +++++++++++++++ README.md | 13 ++++++++++++- 18 files changed, 287 insertions(+), 6 deletions(-) create mode 100644 .Tools/footer.txt diff --git a/.Docs/ASM.md b/.Docs/ASM.md index d0a2fcff..7543d41d 100644 --- a/.Docs/ASM.md +++ b/.Docs/ASM.md @@ -39,5 +39,21 @@ Multi-CPU macro assembler based on S-C MASM 3.0 dialect | .TI | TItle | S-C,A2osX | IGNORED | | | | .US | USer defined | S-C,A2osX | IGNORED | | | +## License +A2osX is licensed under the GNU General Pulic License. - \ No newline at end of file + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + +## Copyright + +Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. diff --git a/.Docs/Command Guide.md b/.Docs/Command Guide.md index 326cc42f..9d5ae18e 100644 --- a/.Docs/Command Guide.md +++ b/.Docs/Command Guide.md @@ -465,6 +465,21 @@ Tool based on UDP socket API, renamed from RPCINFO
RPCDUMP RGXX we need more info on this command. +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + ## Copyright Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. diff --git a/.Docs/Developers Guide.md b/.Docs/Developers Guide.md index 68a57e64..94185051 100644 --- a/.Docs/Developers Guide.md +++ b/.Docs/Developers Guide.md @@ -87,6 +87,21 @@ Basically you are going to have to use regedit to create the following keys: | [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.2\Client] | "DisabledByDefault"=dword:00000000 "Enabled"=dword:00000001 | | [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.2\Server] | "DisabledByDefault"=dword:00000000 "Enabled"=dword:00000001 | +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + ## Copyright Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. diff --git a/.Docs/KERNEL.md b/.Docs/KERNEL.md index e8ccf648..62b1934e 100644 --- a/.Docs/KERNEL.md +++ b/.Docs/KERNEL.md @@ -1,5 +1,8 @@ *** Auto generated by docgen.cmd *** +## Copyright +Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. + # Args2ArgV Expand String and convert to ArgV List @@ -1430,3 +1433,20 @@ Convert S.TIME struct to CSTR ## RETURN VALUE none. always succeed. + +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + +*** End of Auto generated file *** diff --git a/.Docs/LIBBLKDEV.md b/.Docs/LIBBLKDEV.md index bb3b1fba..36347b21 100644 --- a/.Docs/LIBBLKDEV.md +++ b/.Docs/LIBBLKDEV.md @@ -1,5 +1,8 @@ *** Auto generated by docgen.cmd *** +## Copyright +Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. + # GetProDOSCatSize Compute space needed for ProDOS Catalog @@ -55,3 +58,20 @@ Write a track (NIBBLE) CC : success CS : A = Error A=0, currently starting/seeking... + +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + +*** End of Auto generated file *** diff --git a/.Docs/LIBCRYPT.md b/.Docs/LIBCRYPT.md index c8af72a8..55a4e0a8 100644 --- a/.Docs/LIBCRYPT.md +++ b/.Docs/LIBCRYPT.md @@ -1,5 +1,8 @@ *** Auto generated by docgen.cmd *** +## Copyright +Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. + ## MD5 Return MD5 Hash for input String @@ -50,3 +53,20 @@ Add Data to MD5 computation `>LIBCALL hLIBCRYPT,LIBCRYPT.MD5Finalize` ## RETURN VALUE + +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + +*** End of Auto generated file *** diff --git a/.Docs/LIBGUI.md b/.Docs/LIBGUI.md index 3a42a575..991cded5 100644 --- a/.Docs/LIBGUI.md +++ b/.Docs/LIBGUI.md @@ -1 +1,21 @@ *** Auto generated by docgen.cmd *** + +## Copyright +Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. + +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + +*** End of Auto generated file *** diff --git a/.Docs/LIBPAK.md b/.Docs/LIBPAK.md index 9c4b3d59..e944c589 100644 --- a/.Docs/LIBPAK.md +++ b/.Docs/LIBPAK.md @@ -1,5 +1,8 @@ *** Auto generated by docgen.cmd *** +## Copyright +Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. + # Pak **In:** @@ -15,3 +18,20 @@ PUSHW = Dst PTR S.PAKSTAT **In:** PUSHW = Src PTR Compressed Buffer PUSHW = Dst PTR + +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + +*** End of Auto generated file *** diff --git a/.Docs/LIBTCPIP.md b/.Docs/LIBTCPIP.md index 21585576..8696116c 100644 --- a/.Docs/LIBTCPIP.md +++ b/.Docs/LIBTCPIP.md @@ -1,5 +1,8 @@ *** Auto generated by docgen.cmd *** +## Copyright +Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. + # ARP.Clear Clear ARP Cache **In:** @@ -255,3 +258,20 @@ Get socket table `>LIBCALL hLIBTCPIP,LIBTCPIP.GetTable` ## RETURN VALUE + +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + +*** End of Auto generated file *** diff --git a/.Docs/Media Guide.md b/.Docs/Media Guide.md index b9cf19e4..44cfbbf2 100644 --- a/.Docs/Media Guide.md +++ b/.Docs/Media Guide.md @@ -40,6 +40,21 @@ You can use and/or install A2osX from the media found in our Media directory fou Please note, we plan to change the media set once 0.93 is officially released. Currently, the BUILD media is the primary image used by the developers to hold the most current version of the A2osX binaries (and a copy of the source, although of course GitHub is the primary source repository). You can download the BUILD image and run in your favorite Apple II emulator or copy to CFFA, MicroTurbo or other Hard Disk emulator to boot, run, test and develop programs for A2osX. Once 0.93 is released, we plan to update the media to include RELEASE, STABLE and BUILD editions of the media, like other projects you might find on GitHub; and each of these will include BOOT, INSTALL, SOURCE and EXTRA type media so that users and developers can BOOT or INSTALL A2osX to existing systems as they see fit. +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + ## Copyright Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. diff --git a/.Docs/News.md b/.Docs/News.md index 221bef11..184136d5 100644 --- a/.Docs/News.md +++ b/.Docs/News.md @@ -181,6 +181,20 @@ Anyway, i'm convinced that a small team of developers could reach "version 1.0" Well, let me know if you can bring "fresh blood" to this stuff... +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. ## Copyright diff --git a/.Docs/Screen Shots.md b/.Docs/Screen Shots.md index bbc5d1be..c8c982f1 100644 --- a/.Docs/Screen Shots.md +++ b/.Docs/Screen Shots.md @@ -30,6 +30,21 @@ DHGR Mixed-Mode Graphic primitives.... ![](../.screen-shots/ScreenShot.GFX.png) +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. + ## Copyright Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. diff --git a/.Docs/Shell Developers Guide.md b/.Docs/Shell Developers Guide.md index 4f09011c..b1578438 100644 --- a/.Docs/Shell Developers Guide.md +++ b/.Docs/Shell Developers Guide.md @@ -163,6 +163,20 @@ functions * DIV/MOD +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. ## Copyright diff --git a/.Docs/Technical Spec.md b/.Docs/Technical Spec.md index ac2345fe..03dcd2ce 100644 --- a/.Docs/Technical Spec.md +++ b/.Docs/Technical Spec.md @@ -153,6 +153,20 @@ note : '$VAR' does NOT expand Variable | MEMDUMP | Working | Tool to track memory leak| 0.93 | | RPCDUMP | In Progress | Tool based on UDP socket API, renamed from RPCINFO
RPCDUMP | 0.92 | +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. ## Copyright diff --git a/.Docs/User Guide.md b/.Docs/User Guide.md index 23f7235d..7e7cd777 100644 --- a/.Docs/User Guide.md +++ b/.Docs/User Guide.md @@ -362,6 +362,20 @@ ProDOS or MLI Errors | $57 | 87 | Duplicate Volume| | $5A | 90 | File Structure Damaged| +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. ## Copyright diff --git a/.Tools/docgen.cmd b/.Tools/docgen.cmd index 2e958b39..f0496fbe 100644 --- a/.Tools/docgen.cmd +++ b/.Tools/docgen.cmd @@ -1,6 +1,6 @@ @echo off title A2osX DOC generator -COLOR 2A +COLOR 0A prompt ] SETLOCAL ENABLEEXTENSIONS ENABLEDELAYEDEXPANSION @@ -56,9 +56,9 @@ exit 0 :SCAN (echo *** Auto generated by docgen.cmd *** )>!DOCFILE! -(echo ## Copyright )>!DOCFILE! -(echo )>!DOCFILE! -(echo Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. )>!DOCFILE! +(echo.)>>!DOCFILE! +(echo ## Copyright )>>!DOCFILE! +(echo Copyright 2015 - 2019, Remy Gibert and the A2osX contributors. )>>!DOCFILE! echo. echo Scanning %FILTER% Files... @@ -98,3 +98,6 @@ for /f %%F in ('dir /b /ogn "%SRCDIR%\%FILTER%"') do ( ) ) ) +(type "%~dp0footer.txt")>>!DOCFILE! +(echo.)>>!DOCFILE! +(echo *** End of Auto generated file *** )>>!DOCFILE! diff --git a/.Tools/footer.txt b/.Tools/footer.txt new file mode 100644 index 00000000..a213d693 --- /dev/null +++ b/.Tools/footer.txt @@ -0,0 +1,15 @@ + +## License +A2osX is licensed under the GNU General Pulic License. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. diff --git a/README.md b/README.md index 64da58ec..16440f78 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,19 @@ A draft of the first A2osX User Guide can be found on GitHub **[here](.Docs/User A draft of the first A2osX Notes for Developers can be found on GitHub **[here](.Docs/Developers%20Guide.md)**. ## License +A2osX is licensed under the GNU General Pulic License. -A2osX is made available under the GNU License 2.0. Our Full License can he found **[Here](./License).** + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +The full A2osX license can be found **[Here](../LICENSE)**. ## Copyright