From 61a4872d88a377d4e316bcc5e68aa0b93591a06f Mon Sep 17 00:00:00 2001 From: Glenn Date: Wed, 27 Dec 2023 10:23:13 +0100 Subject: [PATCH] doc: add manpage for igmpgen --- CMakeLists.txt | 3 ++ misc/igmpgen.man.1 | 86 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 89 insertions(+) create mode 100644 misc/igmpgen.man.1 diff --git a/CMakeLists.txt b/CMakeLists.txt index 3b17979..e8eca48 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -33,6 +33,9 @@ target_link_libraries(igmpgen ${LIBNET_LIBRARY}) # Installation instructions install(TARGETS igmpgen DESTINATION bin) +# Install the man page +install(FILES misc/igmpgen.man.1 DESTINATION share/man/man1 RENAME igmpgen.1) + # Include CPack for packaging include(InstallRequiredSystemLibraries) set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.txt") diff --git a/misc/igmpgen.man.1 b/misc/igmpgen.man.1 new file mode 100644 index 0000000..9286855 --- /dev/null +++ b/misc/igmpgen.man.1 @@ -0,0 +1,86 @@ +.TH IGMPGEN 1 "Your Date Here" "Version Number Here" "IGMPGEN Manual" +.SH NAME +igmpgen \- IGMP packet generator + +.SH SYNOPSIS +.B igmpgen +[options] + +.SH DESCRIPTION +.PP +The +.B igmpgen +utility is used to generate IGMP (Internet Group Management Protocol) network packets. + +.SH OPTIONS +.TP +.B \-i +Specify the network interface (e.g., eth0). + +.TP +.B \-t +Specify the IGMP packet type and version (e.g., 1.query). + +.TP +.B \-g +Specify the destination IGMP group (e.g., 224.0.0.1). + +.TP +.B \-s +Specify the source IP and port (e.g., 192.168.1.1:1234). + +.TP +.B \-d +Specify the destination IP and port (e.g., 224.0.0.2:5678). + +.TP +.B \-n +Specify delay between packets in seconds (optional). + +.SH AVAILABLE IGMP PACKET TYPES +.PP +The following IGMP packet types are available: +.PP +\- 1.query +.br +\- 1.report +.br +\- 1.dvmrp +.br +\- 2.query +.br +\- 2.report +.br +\- 2.leave +.br +\- 3.report + +.SH EXAMPLES +.PP +To generate a 1.query IGMP packet on eth0: +.PP +.nf +\fB$ igmpgen -i eth0 -t 1.query\fR +.fi + +.SH AUTHOR +.PP +Written by Your Name. + +.SH "SEE ALSO" +.PP +Related commands or documentation. + +.SH BUGS +.PP +No known bugs. + +.SH LICENSE +.PP +Specify license information or refer to the LICENSE file. + +.SH "REPORTING BUGS" +.PP +Provide information on how to report bugs. + +