mirror of
https://github.com/VARCem/PDCurses.git
synced 2026-09-25 00:05:16 +00:00
Documentation re-org. The "man page" document, minus the intro, is now
included.
This commit is contained in:
3
Makefile
3
Makefile
@@ -10,9 +10,6 @@ TARBALL = $(PDC_DIR).tar.gz
|
||||
all:
|
||||
@echo Look in folders for platform-specific build instructions.
|
||||
|
||||
manual:
|
||||
cd man; $(MAKE) $(MFLAGS) $@
|
||||
|
||||
$(ZIPFILE):
|
||||
zip -9ory $(ZIPFILE) *
|
||||
|
||||
|
||||
@@ -6,7 +6,8 @@ curses for multiple platforms. The latest version can be found at:
|
||||
|
||||
https://pdcurses.org/
|
||||
|
||||
For changes, see the [HISTORY] file.
|
||||
For changes, see the [History] file. The main documentation is now in
|
||||
the [man] directory.
|
||||
|
||||
|
||||
Legal Stuff
|
||||
@@ -54,7 +55,8 @@ Maintainer
|
||||
|
||||
William McBrine <wmcbrine@gmail.com>
|
||||
|
||||
[HISTORY]: HISTORY.md
|
||||
[History]: man/HISTORY.md
|
||||
[man]: man/README.md
|
||||
[DOS]: dos/README.md
|
||||
[OS/2]: os2/README.md
|
||||
[SDL 1.x]: sdl1/README.md
|
||||
|
||||
2933
man/MANUAL.md
Normal file
2933
man/MANUAL.md
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,18 +1,42 @@
|
||||
PDCurses Documentation
|
||||
======================
|
||||
|
||||
A plain text document to provide a basic overview of PDCurses, along
|
||||
with a program to combine it with the "man page" sections from the
|
||||
source code files, into "PDCurses.md".
|
||||
The main documentation for PDCurses is here:
|
||||
|
||||
- [User's Guide] - Basic overview
|
||||
- [Implementor's Guide] - What you need to know to port PDCurses
|
||||
- [Manual] - Each function, etc.
|
||||
- [History]
|
||||
|
||||
Also consult the README for each specific platform you'll be using:
|
||||
|
||||
- [DOS]
|
||||
- [OS/2]
|
||||
- [SDL 1.x]
|
||||
- [SDL 2.x]
|
||||
- [Windows]
|
||||
- [X11]
|
||||
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
- Type "./mkman.sh". Needs a Unix-like shell and a Python interpreter.
|
||||
- To rebuild MANUAL.md from the "man page" sections of the source code,
|
||||
type "./mkman.sh". Needs a Unix-like shell and a Python interpreter.
|
||||
|
||||
|
||||
Distribution Status
|
||||
-------------------
|
||||
|
||||
The files in this directory are released to the Public Domain.
|
||||
|
||||
[User's Guide]: USERS.md
|
||||
[Implementor's Guide]: IMPLEMNT.md
|
||||
[Manual]: MANUAL.md
|
||||
[History]: HISTORY.md
|
||||
[DOS]: ../dos/README.md
|
||||
[OS/2]: ../os2/README.md
|
||||
[SDL 1.x]: ../sdl1/README.md
|
||||
[SDL 2.x]: ../sdl2/README.md
|
||||
[Windows]: ../wincon/README.md
|
||||
[X11]: ../x11/README.md
|
||||
|
||||
@@ -355,5 +355,3 @@ This list is incomplete -- see curses.h for the full list, and use the
|
||||
testcurs demo to see what values are actually returned. The above are
|
||||
just the keys required by X/Open. In particular, PDCurses defines many
|
||||
CTL_ and ALT_ combinations; these are not portable.
|
||||
|
||||
--------------------------------------------------------------------------
|
||||
15
man/mkman.sh
15
man/mkman.sh
@@ -1,8 +1,7 @@
|
||||
cat intro.md > PDCurses.md
|
||||
echo PDCurses Definitions and Variables >> PDCurses.md
|
||||
echo ================================== >> PDCurses.md
|
||||
./manext.py ../curses.h >> PDCurses.md
|
||||
echo PDCurses Functions >> PDCurses.md
|
||||
echo ================== >> PDCurses.md
|
||||
./manext.py ../pdcurses/*.c >> PDCurses.md
|
||||
./manext.py ../x11/*.c >> PDCurses.md
|
||||
echo PDCurses Definitions and Variables > MANUAL.md
|
||||
echo ================================== >> MANUAL.md
|
||||
./manext.py ../curses.h >> MANUAL.md
|
||||
echo PDCurses Functions >> MANUAL.md
|
||||
echo ================== >> MANUAL.md
|
||||
./manext.py ../pdcurses/*.c >> MANUAL.md
|
||||
./manext.py ../x11/*.c >> MANUAL.md
|
||||
|
||||
Reference in New Issue
Block a user