Add bin/ax25dump.8
Initial implementation of bin/ax25dump.8 man page
Other changes:
    * Make consistent mention of [tioarg ...], rather than tioflags
      or tioargs
    * Small bin/Makefile improvements to assist in installing man
      pages for different manual sections
			
			
This commit is contained in:
		
							parent
							
								
									cc530fcccc
								
							
						
					
					
						commit
						0886730131
					
				
					 3 changed files with 49 additions and 3 deletions
				
			
		| 
						 | 
				
			
			@ -9,7 +9,8 @@ CFLAGS		+= -I$(INCLUDE_PATH)
 | 
			
		|||
LDFLAGS		= -L../src -lpatty
 | 
			
		||||
 | 
			
		||||
PROGRAMS	= pattyd ax25dump
 | 
			
		||||
MANPAGES	= pattyd.8
 | 
			
		||||
MAN8PAGES	= pattyd.8 ax25dump.8
 | 
			
		||||
MANPAGES	= $(MAN8PAGES)
 | 
			
		||||
 | 
			
		||||
HEADERS		= kiss.h if.h
 | 
			
		||||
HEADERS_BUILD	= $(addprefix $(INCLUDE_PATH)/$(HEADERS_SUBDIR)/, $(HEADERS))
 | 
			
		||||
| 
						 | 
				
			
			@ -20,7 +21,7 @@ all: $(PROGRAMS)
 | 
			
		|||
 | 
			
		||||
install: $(PROGRAMS) $(MANPAGES)
 | 
			
		||||
	$(INSTALL) -d -m 0755 $(MANDIR)/man8
 | 
			
		||||
	$(INSTALL) -c -m 0644 pattyd.8 $(MANDIR)/man8
 | 
			
		||||
	$(INSTALL) -c -m 0644 $(MAN8PAGES) $(MANDIR)/man8
 | 
			
		||||
	$(INSTALL) -c -m 0755 $(PROGRAMS) $(PREFIX)/bin
 | 
			
		||||
 | 
			
		||||
pattyd: pattyd.o kiss.o if.o
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										45
									
								
								bin/ax25dump.8
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										45
									
								
								bin/ax25dump.8
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,45 @@
 | 
			
		|||
.Dd $Mdocdate$
 | 
			
		||||
.Dt AX25DUMP 8
 | 
			
		||||
.Os
 | 
			
		||||
.Sh NAME
 | 
			
		||||
.Nm ax25dump
 | 
			
		||||
.Nd dump AX.25 traffic
 | 
			
		||||
.Sh SYNOPSIS
 | 
			
		||||
.Nm
 | 
			
		||||
.Ar patty.sock ifname
 | 
			
		||||
.Nm
 | 
			
		||||
.Ar /dev/ttyXYZ Op tioarg ...
 | 
			
		||||
.Nm
 | 
			
		||||
.Ar file.cap
 | 
			
		||||
.Sh DESCRIPTION
 | 
			
		||||
.Nm
 | 
			
		||||
prints out the headers and bodies of packets sent or received by an AX.25
 | 
			
		||||
interface, a raw KISS TNC device, or a regular file containing KISS-framed
 | 
			
		||||
AX.25 packets.
 | 
			
		||||
.Pp
 | 
			
		||||
When provided with a
 | 
			
		||||
.Ar patty.sock
 | 
			
		||||
Unix domain socket to a
 | 
			
		||||
.Xr pattyd 8
 | 
			
		||||
instance, and an
 | 
			
		||||
.Ar ifname ,
 | 
			
		||||
.Nm
 | 
			
		||||
will dump all packets sent and received by
 | 
			
		||||
.Ar ifname .
 | 
			
		||||
.Pp
 | 
			
		||||
When provided with a KISS TNC device,
 | 
			
		||||
.Ar /dev/ttyXYZ ,
 | 
			
		||||
with optional
 | 
			
		||||
.Xr termios 4
 | 
			
		||||
settings, or with a regular file,
 | 
			
		||||
.Ar file.cap ,
 | 
			
		||||
.Nm
 | 
			
		||||
will dump all KISS-framed packets received by that device or contained in that
 | 
			
		||||
file.
 | 
			
		||||
.Pp
 | 
			
		||||
When provided with a KISS TNC device, zero or more
 | 
			
		||||
.Op tioarg ...
 | 
			
		||||
may be given to specify baud or flow control.  Valid settings are:
 | 
			
		||||
.Li 1200 , 9600 , crtscts , xonxoff .
 | 
			
		||||
.Sh AUTHORS
 | 
			
		||||
.An XANTRONIX Development Aq Mt dev@xantronix.com
 | 
			
		||||
| 
						 | 
				
			
			@ -28,7 +28,7 @@ static void usage(int argc, char **argv, const char *message, ...) {
 | 
			
		|||
    }
 | 
			
		||||
 | 
			
		||||
    fprintf(stderr, "usage: %s /var/run/patty/patty.sock ifname\n"
 | 
			
		||||
                    "       %s /dev/ttyXYZ [tioargs ...]\n"
 | 
			
		||||
                    "       %s /dev/ttyXYZ [tioarg ...]\n"
 | 
			
		||||
                    "       %s file.cap\n", argv[0], argv[0], argv[0]);
 | 
			
		||||
 | 
			
		||||
    exit(EX_USAGE);
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		
		Reference in a new issue