From ed4cf84819eeeb4984c1f26fc759a90ae35de924 Mon Sep 17 00:00:00 2001 From: Cosmin Truta Date: Sat, 14 Sep 2024 23:00:13 +0300 Subject: [PATCH] doc: Move all manuals to the manuals/ directory Create the manuals/ directory for storing the software manuals and the man pages. The upcoming Markdown versions of these document are also planned to be added here. Move in the manual files as follows: * Move libpng.3 and libpng.5 to manuals/libpng.3 and manuals/libpng.5 * Move libpng-manual.txt to manuals/libpng-manual.txt * Move INSTALL.txt to manuals/libpng-install.txt * Remove libpngpf.3 Finally, update the README file, as well as the makefiles and the CMake file, in order to reflect these changes. --- CMakeLists.txt | 4 ++-- Makefile.am | 2 +- Makefile.in | 2 +- README.md | 22 ++++++++--------- libpngpf.3 | 24 ------------------- INSTALL.txt => manuals/libpng-install.txt | 0 .../libpng-manual.txt | 0 libpng.3 => manuals/libpng.3 | 0 png.5 => manuals/png.5 | 0 9 files changed, 15 insertions(+), 39 deletions(-) delete mode 100644 libpngpf.3 rename INSTALL.txt => manuals/libpng-install.txt (100%) rename libpng-manual.txt => manuals/libpng-manual.txt (100%) rename libpng.3 => manuals/libpng.3 (100%) rename png.5 => manuals/png.5 (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index ee5d38774c..8fd8fa0077 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1109,9 +1109,9 @@ endif() if(NOT SKIP_INSTALL_FILES AND NOT SKIP_INSTALL_ALL) # Install the man pages. - install(FILES libpng.3 libpngpf.3 + install(FILES manuals/libpng.3 DESTINATION ${CMAKE_INSTALL_MANDIR}/man3) - install(FILES png.5 + install(FILES manuals/png.5 DESTINATION ${CMAKE_INSTALL_MANDIR}/man5) # Install the pkg-config files. if(NOT CMAKE_HOST_WIN32 OR CYGWIN OR MINGW) diff --git a/Makefile.am b/Makefile.am index eed986c2b8..e2e28e4e97 100644 --- a/Makefile.am +++ b/Makefile.am @@ -91,7 +91,7 @@ TESTS =\ endif # man pages -dist_man_MANS= libpng.3 libpngpf.3 png.5 +dist_man_MANS= manuals/libpng.3 manuals/png.5 # generate the -config scripts if required binconfigs= libpng@PNGLIB_MAJOR@@PNGLIB_MINOR@-config diff --git a/Makefile.in b/Makefile.in index 44b6936b7d..239afd1e4f 100644 --- a/Makefile.in +++ b/Makefile.in @@ -812,7 +812,7 @@ BUILT_SOURCES = pnglibconf.h # man pages -dist_man_MANS = libpng.3 libpngpf.3 png.5 +dist_man_MANS = manuals/libpng.3 manuals/png.5 EXTRA_SCRIPTS = libpng-config libpng@PNGLIB_MAJOR@@PNGLIB_MINOR@-config bin_SCRIPTS = @binconfigs@ diff --git a/README.md b/README.md index 2fbde72691..bf54bbb2fd 100644 --- a/README.md +++ b/README.md @@ -104,19 +104,14 @@ filter heuristics, have since been removed. Files included in this distribution ----------------------------------- - ANNOUNCE => Announcement of this version, with recent changes - AUTHORS => List of contributing authors + ANNOUNCE.md => Announcement of this version, with recent changes + AUTHORS.md => List of contributing authors CHANGES => Description of changes between libpng versions - INSTALL => Instructions to install libpng - LICENSE => License to use and redistribute libpng - README => This file - TODO => Things not implemented in the current library - TRADEMARK => Trademark information + LICENSE.md => License to use and redistribute libpng + README.md => This file + TODO.md => Things not implemented in the current library + TRADEMARK.md => Trademark information example.c => Example code for using libpng functions - libpng.3 => Manual page for libpng (includes libpng-manual.txt) - libpng-manual.txt => Description of libpng and its functions - libpngpf.3 => Manual page for libpng's private functions (deprecated) - png.5 => Manual page for the PNG format png.c => Basic interface functions common to library png.h => Library function and interface declarations (public) pngpriv.h => Library function and interface declarations (private) @@ -165,6 +160,11 @@ Files included in this distribution testpngs/ => Test images tools/ => Various tools visupng/ => VisualPng, a Windows viewer for PNG images + manuals/ => Manuals + libpng-install.txt => Instructions to install libpng + libpng-manual.txt => Description of libpng and its functions + libpng.3 => Manual page for libpng (includes libpng-manual.txt) + png.5 => Manual page for the PNG format projects/ => Project files and workspaces for various IDEs owatcom/ => OpenWatcom project visualc71/ => Microsoft Visual C++ 7.1 workspace diff --git a/libpngpf.3 b/libpngpf.3 deleted file mode 100644 index b7557ca27e..0000000000 --- a/libpngpf.3 +++ /dev/null @@ -1,24 +0,0 @@ -.TH LIBPNGPF 3 "September 12, 2024" -.SH NAME -libpng \- Portable Network Graphics (PNG) Reference Library 1.6.44 -(private functions) - -.SH SYNOPSIS -\fB#include \fI"pngpriv.h" - -\fBAs of libpng version \fP\fI1.5.1\fP\fB, this section is no longer -\fP\fImaintained\fP\fB, now that the private function prototypes are hidden in -\fP\fIpngpriv.h\fP\fB and not accessible to applications. Look in -\fP\fIpngpriv.h\fP\fB for the prototypes and a short description of each -function. - -.SH DESCRIPTION -The functions previously listed here are used privately by libpng and are not -available for use by applications. They are not "exported" to applications -using shared libraries. - -.SH "SEE ALSO" -.BR "png"(5), " libpng"(3), " zlib"(3), " deflate"(5), " " and " zlib"(5) - -.SH AUTHORS -Cosmin Truta, Glenn Randers-Pehrson diff --git a/INSTALL.txt b/manuals/libpng-install.txt similarity index 100% rename from INSTALL.txt rename to manuals/libpng-install.txt diff --git a/libpng-manual.txt b/manuals/libpng-manual.txt similarity index 100% rename from libpng-manual.txt rename to manuals/libpng-manual.txt diff --git a/libpng.3 b/manuals/libpng.3 similarity index 100% rename from libpng.3 rename to manuals/libpng.3 diff --git a/png.5 b/manuals/png.5 similarity index 100% rename from png.5 rename to manuals/png.5