From ac1dfea8c14071291f7e090420d660991b1963c2 Mon Sep 17 00:00:00 2001 From: Joachim Nilsson Date: Sun, 29 Sep 2019 12:51:22 +0200 Subject: doc: Clean up libnet-config and generated html files - Remove last traces of libnet-config tool - Remove generated HTML files Signed-off-by: Joachim Nilsson --- doc/fixmanpages.in | 13 +- doc/html/closed.png | Bin 132 -> 0 bytes doc/html/globals_func.html | 431 --------------------------------------------- doc/html/tab_s.png | Bin 184 -> 0 bytes doc/libnet-config.Pod | 92 ---------- doc/libnet.chm | Bin 212086 -> 0 bytes 6 files changed, 5 insertions(+), 531 deletions(-) delete mode 100644 doc/html/closed.png delete mode 100644 doc/html/globals_func.html delete mode 100644 doc/html/tab_s.png delete mode 100644 doc/libnet-config.Pod delete mode 100644 doc/libnet.chm diff --git a/doc/fixmanpages.in b/doc/fixmanpages.in index 0270b45..967cbc8 100644 --- a/doc/fixmanpages.in +++ b/doc/fixmanpages.in @@ -2,9 +2,9 @@ # Doxygen's man page generation is unfortunately very rudimentary. # -# So in addition to creating the libnet(3) and the libnet-config(1) man page -# from two pod files, this (over-documented) script will also try to add a few -# "finishing touches" to the two (or three or more) man pages generated by Doxygen. +# So in addition to creating the libnet(3) man page from pod file, this +# script also tries to add a few "finishing touches" to man pages +# generated by Doxygen. # # It will run after building libnet and after Doxygen generated all its # documentations. If you ever have to run it manually, you should do the same. @@ -13,7 +13,7 @@ echo "Finalizing man pages..." -MANPAGENOTE='.SH "SEE ALSO"\n\.IX Header "SEE ALSO"\nlibnet(3), libnet\-config(1)\n.SH "AUTHORS"\n.IX Header "AUTHORS"\nThe original author of libnet is Mike D. Schiffman.\n.PP\nlibnet has been maintained and extensively enhanced since 2009 by Sam Roberts.\n.PP\nIt is currently maintained by Ali Abdulkadir and available at\n.PP\n.Vb 1\n\& \n.Ve\n.SH "BUGS"\n.IX Header "BUGS"\nFor bugs, questions, patch submissions, desirable enhancements, etc. see:\n.PP\n.Vb 1\n\& \n.Ve\n.SH "COPYRIGHT"\n.IX Header "COPYRIGHT"\nlibnet is licensed under the 3\-Clause \s-1BSD\s0 License. You can basically\ndo whatever you want with it.' +MANPAGENOTE='.SH "SEE ALSO"\n\.IX Header "SEE ALSO"\nlibnet(3)\n.SH "AUTHORS"\n.IX Header "AUTHORS"\nThe original author of libnet is Mike D. Schiffman.\n.PP\nlibnet has been maintained and extensively enhanced since 2009 by Sam Roberts.\n.PP\nIt is currently maintained by Ali Abdulkadir and available at\n.PP\n.Vb 1\n\& \n.Ve\n.SH "BUGS"\n.IX Header "BUGS"\nFor bugs, questions, patch submissions, desirable enhancements, etc. see:\n.PP\n.Vb 1\n\& \n.Ve\n.SH "COPYRIGHT"\n.IX Header "COPYRIGHT"\nlibnet is licensed under the 3\-Clause \s-1BSD\s0 License. You can basically\ndo whatever you want with it.' die() { echo "$*" 1>&2 @@ -26,7 +26,6 @@ if test x"$MANDIR" = x ; then fi test -d $MANDIR/man3 || die "Could not locate $MANDIR/man3 directory." -test -d $MANDIR/man1 || mkdir $MANDIR/man1 || die "Could not create $MANDIR/man1 directory." # For now, I will let Doxygen still produces its useless and totally misleading # man page for "libnet.h" and simply delete it now. That's mostly because not @@ -34,7 +33,7 @@ test -d $MANDIR/man1 || mkdir $MANDIR/man1 || die "Could not create $MANDIR/man1 # And we wouldn't want that, would we? find $MANDIR/man3/ -name "libnet.h.3" -exec sh -c 'rm -f "$1"' _ {} \; -# Let's create libnet.3 and the libnet-config.3 before dealing with the rest. +# Let's create libnet.3 before dealing with the rest. # BTW: We're using this hideous date format because Doxygen generated man # pages have them set like this and our date format shouldn't look different. @@ -42,8 +41,6 @@ pod2man -d "$(date +%a\ %b\ %d\ %C%y)" -n LIBNET -c "libnet Programmers Guide" - # pod2html --title="libnet Programmers Guide" --noindex --infile=libnet.Pod --outfile=libnet.html -pod2man -d "$(date +%a\ %b\ %d\ %C%y)" -n LIBNET-CONFIG -c "General Commands Manual" -s 1 -r "@PACKAGE_NAME@-@PACKAGE_VERSION@" @top_srcdir@/doc/libnet-config.Pod man/man1/libnet-config.1 || die "Could not create libnet-config.1 in $MANDIR/man/man1." - cd "$MANDIR/man3" || die "Could not cd into $MANDIR/man3" # A little housekeeping... diff --git a/doc/html/closed.png b/doc/html/closed.png deleted file mode 100644 index 98cc2c9..0000000 Binary files a/doc/html/closed.png and /dev/null differ diff --git a/doc/html/globals_func.html b/doc/html/globals_func.html deleted file mode 100644 index 1d703d0..0000000 --- a/doc/html/globals_func.html +++ /dev/null @@ -1,431 +0,0 @@ - - - - - - - -libnet: Globals - - - - - - -
-
- - - - - - -
-
libnet -  1.1 -
-
-
- - - - - - -
-
-  - -

- l -

-
- -
-Generated on Sat Sep 28 2019 11:13:34 for libnet by   -doxygen - 1.8.13 -
- - diff --git a/doc/html/tab_s.png b/doc/html/tab_s.png deleted file mode 100644 index ab478c9..0000000 Binary files a/doc/html/tab_s.png and /dev/null differ diff --git a/doc/libnet-config.Pod b/doc/libnet-config.Pod deleted file mode 100644 index 91ca1e7..0000000 --- a/doc/libnet-config.Pod +++ /dev/null @@ -1,92 +0,0 @@ -=pod - -=encoding utf8 - -=head1 NAME - -libnet-config - script to get information about, and for linking against libnet - -=head1 SYNOPSIS - -B - -=head1 DESCRIPTION - -libnet-config tells the application programmer what flags to use to compile and -link programs against an installed L library. - -An alternative (and perhaps more convenient) method of retrieving the various -configuration information needed to compile programs that use libnet is to use -the L program. Pkg-config support was added in version 1.2. - -Both methods write to standard output the flags that should be used to compile -and link programs that use libnet. - -=head1 OPTIONS - -=over 8 - -=item B<--help> - -Print a usage message and exit. This is the default behavior when no options are -specified. - -=item B<--version> - -Print version information and exit. - -=item B<--libs> - -Print the linker flags (LDFLAGS) that are necessary to link a programs with -libnet. - -=item B<--cflags> - -Print the compiler options (CFLAGS) to use when compiling files that use libnet. -Currently that is only the include path to the libnet include files. - -=item B<--defines> - -Print the pre-processor definitions libnet was compiler with. - -=item B<--prefix> - -Print the prefix used when libnet was installed. The prefix can be set during -the build process with "configure --prefix". - -=back - -=head1 EXAMPLES - -To print all linker options needed when linking with libnet, use - -B> - -To build the singe-file C program 'prog' against the libnet library, use - -B> - -The same in a Makefile: - -B - -B - -B - -To build a dynamically loadable libnet module, use - -B> - -Note that libnet-config can also be called from 'configure' scripts. - -=head1 SEE ALSO - -L, L - -=head1 AUTHORS - -This manual page was written by Ali Abdulkadir - -=cut - diff --git a/doc/libnet.chm b/doc/libnet.chm deleted file mode 100644 index 5193ca2..0000000 Binary files a/doc/libnet.chm and /dev/null differ -- cgit v1.2.1