From bf960f64440a3445e84d83f23a44c19f7bd870b1 Mon Sep 17 00:00:00 2001 From: Samuel Jero Date: Sat, 29 Dec 2012 20:26:27 -0500 Subject: [PATCH] Add manpage --- Makefile | 14 +++++----- dccpping.pod | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+), 6 deletions(-) create mode 100644 dccpping.pod diff --git a/Makefile b/Makefile index 9793535..2065af9 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ ############################################################################### #Author: Samuel Jero # -# Date: 11/2011 +# Date: 12/2012 # # Makefile for program dccpping ############################################################################### @@ -13,7 +13,7 @@ CC = gcc BINDIR = /usr/local/bin MANDIR = /usr/local/man -all: dccpping +all: dccpping dccpping.1 dccpping: dccpping.c checksums.h checksums.o Makefile ${CC} ${CFLAGS} dccpping.c checksums.o -odccpping @@ -21,14 +21,16 @@ dccpping: dccpping.c checksums.h checksums.o Makefile checksums.o: checksums.c checksums.h Makefile ${CC} ${CFLAGS} -c checksums.c -ochecksums.o +dccpping.1: dccpping.pod + pod2man -s 1 -c "dccpping" dccpping.pod > dccpping.1 -install: dccpping +install: dccpping dccpping.1 install -m 4755 -o root -g root dccpping ${BINDIR}/dccpping -# install -m 444 -o bin -g bin dccpping.1 ${MANDIR}/man1/dccpping.1 + install -m 444 -o bin -g bin dccpping.1 ${MANDIR}/man1/dccpping.1 uninstall: rm -f ${BINDIR}/dccpping -# rm -r ${MANDIR}/man1/dccpping.1 + rm -f ${MANDIR}/man1/dccpping.1 clean: - rm -f *~ dccpping core *.o \ No newline at end of file + rm -f *~ dccpping core *.o dccpping.1 diff --git a/dccpping.pod b/dccpping.pod new file mode 100644 index 0000000..324ba0f --- /dev/null +++ b/dccpping.pod @@ -0,0 +1,72 @@ +=head1 NAME + +dccpping - send DCCP Request packets to network hosts + +=head1 SYNOPSIS + +B [-v] [-V] [-h] [-n] [-6|-4] [-c I] [-p I] [-i I] [-t I] [-s I] [-S I] I + +=head1 DESCRIPTION + +B uses DCCP Request packets to elicit a response from a host or gateway. + +For each response received, a line of information about the type of response (DCCP packet + or ICMP error) and the round trip time are printed. Upon termination, statistics about +the loss rate and round trip times are printed. + +B uses the well-known "half-open technique", which prevents applications on +the destination host from seeing our probes at all. Normally, a DCCP Request is sent. +For non-listened ports we receive a DCCP Reset, and all is done. For active listening +ports we receive DCCP Response, but answer with a DCCP Reset (instead of the expected +DCCP Ack), this way the remote DCCP session is closed without the application ever +noticing. + +=head1 OPTIONS + +=over 5 + +=item B<-v> Verbose. May be repeated for aditional verbosity. + +=item B<-V> Version information + +=item B<-h> Help + +=item B<-6> Force IPv6 mode + +=item B<-4> Force IPv4 mode + +=item B<-n> Numeric output only. No attempt will be made to lookup symbolic names for host addresses. + +=item B<-c> I + +Stop after sending I requests. The default is unlimited. + +=item B<-p> I + +Send requests to DCCP port I. The default is 33434. + +=item B<-i> I + +Wait I seconds between sending requests. The default is 1 second. + +=item B<-t> I + +Set the IP Time to Live. The default is 64. + +=item B<-s> I + +Set the DCCP service code to use in requests. + +=item B<-S> I + +Set source address to specified address. Must be a valid address on some interface. + +=back + +=head1 AUTHOR + +Samuel Jero + +=head1 SEE ALSO + +B(8) -- 2.39.2