From 4e1929b059c8249870e628cc4dae129cd5e18ec9 Mon Sep 17 00:00:00 2001 From: Ralf Baechle Date: Sun, 11 Dec 2011 17:32:51 +0000 Subject: Apply program name transformations also to man page content. For now these options are just honored for the call.1 and listen.1 man pages because these days these two programs generally get renamed to avoid naming conflicts with other programs. --- call/Makefile.am | 17 +++++ call/call.1 | 194 ----------------------------------------------------- call/call.man | 194 +++++++++++++++++++++++++++++++++++++++++++++++++++++ listen/Makefile.am | 19 +++++- listen/listen.1 | 91 ------------------------- listen/listen.man | 91 +++++++++++++++++++++++++ 6 files changed, 320 insertions(+), 286 deletions(-) delete mode 100644 call/call.1 create mode 100644 call/call.man delete mode 100644 listen/listen.1 create mode 100644 listen/listen.man diff --git a/call/Makefile.am b/call/Makefile.am index 9668863..70df548 100644 --- a/call/Makefile.am +++ b/call/Makefile.am @@ -8,9 +8,26 @@ installconf: bin_PROGRAMS = call man_MANS = call.1 +CLEANFILES = call.1 call.1.tmp EXTRA_DIST = $(man_MANS) +call.1 : call.man + name_call=$$(echo call | sed -e '$(transform)') \ + name_Call=$$(echo $$name_call | sed -r 's@^(.)@\U\1\E@') && \ + name_CALL=$$(echo $$name_call | sed -r 's@^(.*)@\U\1\E@') && \ + name_listen=$$(echo listen | sed -e '$(transform)') \ + name_Listen=$$(echo $$name_listen | sed -r 's@^(.)@\U\1\E@') && \ + name_LISTEN=$$(echo $$name_listen | sed -r 's@^(.*)@\U\1\E@') &&\ + sed -e "s/@@@call@@@/$$name_call/g" \ + -e "s/@@@Call@@@/$$name_Call/g" \ + -e "s/@@@CALL@@@/$$name_CALL/g" \ + -e "s/@@@listen@@@/$$name_listen/g" \ + -e "s/@@@Listen@@@/$$name_Listen/g" \ + -e "s/@@@LISTEN@@@/$$name_LISTEN/g" \ + call.man > call.1.tmp && \ + mv call.1.tmp call.1; + call_LDADD = $(NCURSES_LIB) $(AX25_LIB) call_SOURCES = \ diff --git a/call/call.1 b/call/call.1 deleted file mode 100644 index e4236b8..0000000 --- a/call/call.1 +++ /dev/null @@ -1,194 +0,0 @@ -.TH CALL 1 "27 August 1996" Linux "Linux Programmer's Manual" -.SH NAME -call \- make an AX.25, NET/ROM or Rose connection. -.SH SYNOPSIS -For AX.25 -.br -.B call [-b l|e] [-d] [-h] [-m s|e] [-p paclen] [-s mycall] [-r] [-t] [-T timeout] [-v] [-w window] [-W] port callsign [[via] digipeaters.....] -.sp 1 -For NET/ROM -.br -.B call [-d] [-h] [-p paclen] [-r] [-t] [-v] port callsign -.sp 1 -For Rose -.br -.B call [-d] [-h] [-r] [-t] [-v] port callsign address [[via] digipeater] -.br -.SH DESCRIPTION -.LP -.B Call -is the general purpose AX.25, NET/ROM and Rose connection program. As is normal -in AX.25 it runs entirely in line mode. All CR/LF translation is done -transparently. The program provides ASCII, YAPP, YAPP-C and 7+ file -transfer facilities. Some of the options are only valid in AX.25 mode, -the program will quietly ignore them if given in NET/ROM mode or in Rose -mode. -.LP -This version of -.B call -incorporates many changes that include a much improved user interface. The -port name is mandatory and is the name of the port which the connection will -be made on. The port name may be either an AX.25, a NET/ROM port or a Rose -port, -.B call -will determine which automatically. -.LP -When using NET/ROM the use of digipeaters is meaningless and is not -supported. However when using Rose up to one digipeater may be specified, as -well as the Rose address of the distant node and the callsign of the remote -station. The Rose address must be ten digits long and it must exist in the -Rose node tables. For Rose connects to work -.B axparms -must have been used to set a callsign/uid mapping for the userid in use. -.SH OPTIONS -.TP 10 -.BI "\-b l|e" -Sets the method of backoff to use with AX.25 connections. The default is -taken from the port specification, but can be overridden by this option. -Valid values are -.B l -for linear backoff, and -.B e -for exponential backoff. -.TP 10 -.BI \-d -Turn on socket level debugging. -.TP 10 -.BI \-h -Selects Slave mode. -.TP 10 -.BI "\-m s|e" -Sets the AX.25 mode to use. The default is taken from the port -specification, but can be overridden by this option. Valid values are -.B s -for normal (modulus 8) AX.25 operation, or -.B e -for extended (modulus 128) AX.25 operation. -.TP 10 -.BI "\-p paclen" -Specify a specific maximum amount of data to be sent in each AX.25 packet. -.TP 10 -.BI "\-s mycall" -Connect using the specified source call (you may need to be root). -.TP 10 -.BI \-R -Disable all remote commands like autobin (#BIN#), 7plus downloads, //echo, etc. -This is useful for scripting where you just don't like the remote site to trigger uncaught conditions here. -.TP 10 -.BI \-S -Be silent. Useful for using call in shellscripts (together with option \-r) in order to be really transparent. -.TP 10 -.BI "\-T timeout" -Set idle timeout seconds after a connection will be closed automaticaly when there's no data being transferred (in- and outbound). If timeout is set to 3600, the connection will close after 1h inactivity. A value of 0.5 is 500ms. -.TP 10 -.BI \-r -Selects Raw mode. -.TP 10 -.BI \-t -Selects Talk mode. -.TP 10 -.BI \-v -Display the version. -.TP 10 -.BI "\-w window" -Specify a specific AX.25 window for this connection. Only valid in AX.25 mode. -.TP 10 -.BI "\-W" -Wait for remote disconnect even if stdin is closed. Normaly, "echo q | call ax0 db0fhn" closes immediately after "echo q" terminates; thus we never see the greeting from db0fhn. With the -W option, call waits until the ax25-connection is disconnected (i.e. db0fhn disconnects after "q" command). Very useful for scripting. You might like to combine it with the -T option. -.LP -The call program interprets lines beginning with a '~' specially. -The following '~' escapes are available. -.TP 16 -.BI ~? -List escapes -.TP 16 -.BI ~~ -A ~ symbol -.TP 16 -.BI ~. -Close connection -.TP 16 -.BI "~! [command]" -Run a command -.TP 16 -.BI ~0 -Change to Raw mode -.TP 16 -.BI ~1 -Change to Slave mode -.TP 16 -.BI ~2 -Change to Talk mode -.TP 16 -.BI ~a -Start a file transfer (Autobin) -.TP 16 -.BI ~b -Start a file transfer (Binary) -.TP 16 -.BI ~c -Close the logfile -.TP 16 -.BI ~h -List escapes -.TP 16 -.BI "~o [filename]" -Open a logfile (default 'logfile.txt') -.TP 16 -.BI ~r -Reconnect to remote station -.TP 16 -.BI ~s -Stop an upload -.TP 16 -.BI "~u [filename]" -Upload a file (ASCII upload) -.TP 16 -.BI "~yu [filename]" -Upload a file (YAPP upload) -.TP 16 -.BI "~yd [filename]" -Download a file (YAPP download) -.TP 16 -.BI ~z -Suspend program -.LP -The program provides no terminal emulation features. These are left -up to the console facilities of the terminal in use. The program is -however '8 bit clean'. -.SH FILES -.nf -/proc/net/nr_nodes -.br -/proc/net/rose_nodes -.br -/etc/ax25/axports -.br -/etc/ax25/nrports -.br -/etc/ax25/rsports -.fi -.SH "SEE ALSO" -.BR listen (1), -.BR mheard (1), -.BR ax25 (4), -.BR netrom (4), -.BR rose (4), -.BR axports (5), -.BR nrports (5), -.BR rsports (5), -.BR axparms (8), -.BR nrparms (8), -.BR rsparms (8). -.SH AUTHORS -.nf -Alexander Tietzel DG6XA -.br -Joerg Reuter DL1BKE -.br -Alan Cox GW4PTS -.br -Jonathan Naylor G4KLX -.br -Steve Henson G6IXS -.fi diff --git a/call/call.man b/call/call.man new file mode 100644 index 0000000..85c291b --- /dev/null +++ b/call/call.man @@ -0,0 +1,194 @@ +.TH @@@CALL@@@ 1 "27 August 1996" Linux "Linux Programmer's Manual" +.SH NAME +@@@call@@@ \- make an AX.25, NET/ROM or Rose connection. +.SH SYNOPSIS +For AX.25 +.br +.B @@@call@@@ [-b l|e] [-d] [-h] [-m s|e] [-p paclen] [-s mycall] [-r] [-t] [-T timeout] [-v] [-w window] [-W] port callsign [[via] digipeaters.....] +.sp 1 +For NET/ROM +.br +.B @@@call@@@ [-d] [-h] [-p paclen] [-r] [-t] [-v] port callsign +.sp 1 +For Rose +.br +.B @@@call@@@ [-d] [-h] [-r] [-t] [-v] port callsign address [[via] digipeater] +.br +.SH DESCRIPTION +.LP +.B @@@Call@@@ +is the general purpose AX.25, NET/ROM and Rose connection program. As is normal +in AX.25 it runs entirely in line mode. All CR/LF translation is done +transparently. The program provides ASCII, YAPP, YAPP-C and 7+ file +transfer facilities. Some of the options are only valid in AX.25 mode, +the program will quietly ignore them if given in NET/ROM mode or in Rose +mode. +.LP +This version of +.B @@@call@@@ +incorporates many changes that include a much improved user interface. The +port name is mandatory and is the name of the port which the connection will +be made on. The port name may be either an AX.25, a NET/ROM port or a Rose +port, +.B @@@call@@@ +will determine which automatically. +.LP +When using NET/ROM the use of digipeaters is meaningless and is not +supported. However when using Rose up to one digipeater may be specified, as +well as the Rose address of the distant node and the callsign of the remote +station. The Rose address must be ten digits long and it must exist in the +Rose node tables. For Rose connects to work +.B axparms +must have been used to set a callsign/uid mapping for the userid in use. +.SH OPTIONS +.TP 10 +.BI "\-b l|e" +Sets the method of backoff to use with AX.25 connections. The default is +taken from the port specification, but can be overridden by this option. +Valid values are +.B l +for linear backoff, and +.B e +for exponential backoff. +.TP 10 +.BI \-d +Turn on socket level debugging. +.TP 10 +.BI \-h +Selects Slave mode. +.TP 10 +.BI "\-m s|e" +Sets the AX.25 mode to use. The default is taken from the port +specification, but can be overridden by this option. Valid values are +.B s +for normal (modulus 8) AX.25 operation, or +.B e +for extended (modulus 128) AX.25 operation. +.TP 10 +.BI "\-p paclen" +Specify a specific maximum amount of data to be sent in each AX.25 packet. +.TP 10 +.BI "\-s mycall" +Connect using the specified source @@@call@@@ (you may need to be root). +.TP 10 +.BI \-R +Disable all remote commands like autobin (#BIN#), 7plus downloads, //echo, etc. +This is useful for scripting where you just don't like the remote site to trigger uncaught conditions here. +.TP 10 +.BI \-S +Be silent. Useful for using @@@call@@@ in shellscripts (together with option \-r) in order to be really transparent. +.TP 10 +.BI "\-T timeout" +Set idle timeout seconds after a connection will be closed automaticaly when there's no data being transferred (in- and outbound). If timeout is set to 3600, the connection will close after 1h inactivity. A value of 0.5 is 500ms. +.TP 10 +.BI \-r +Selects Raw mode. +.TP 10 +.BI \-t +Selects Talk mode. +.TP 10 +.BI \-v +Display the version. +.TP 10 +.BI "\-w window" +Specify a specific AX.25 window for this connection. Only valid in AX.25 mode. +.TP 10 +.BI "\-W" +Wait for remote disconnect even if stdin is closed. Normaly, "echo q | @@@call@@@ ax0 db0fhn" closes immediately after "echo q" terminates; thus we never see the greeting from db0fhn. With the -W option, @@@call@@@ waits until the ax25-connection is disconnected (i.e. db0fhn disconnects after "q" command). Very useful for scripting. You might like to combine it with the -T option. +.LP +The @@@call@@@ program interprets lines beginning with a '~' specially. +The following '~' escapes are available. +.TP 16 +.BI ~? +List escapes +.TP 16 +.BI ~~ +A ~ symbol +.TP 16 +.BI ~. +Close connection +.TP 16 +.BI "~! [command]" +Run a command +.TP 16 +.BI ~0 +Change to Raw mode +.TP 16 +.BI ~1 +Change to Slave mode +.TP 16 +.BI ~2 +Change to Talk mode +.TP 16 +.BI ~a +Start a file transfer (Autobin) +.TP 16 +.BI ~b +Start a file transfer (Binary) +.TP 16 +.BI ~c +Close the logfile +.TP 16 +.BI ~h +List escapes +.TP 16 +.BI "~o [filename]" +Open a logfile (default 'logfile.txt') +.TP 16 +.BI ~r +Reconnect to remote station +.TP 16 +.BI ~s +Stop an upload +.TP 16 +.BI "~u [filename]" +Upload a file (ASCII upload) +.TP 16 +.BI "~yu [filename]" +Upload a file (YAPP upload) +.TP 16 +.BI "~yd [filename]" +Download a file (YAPP download) +.TP 16 +.BI ~z +Suspend program +.LP +The program provides no terminal emulation features. These are left +up to the console facilities of the terminal in use. The program is +however '8 bit clean'. +.SH FILES +.nf +/proc/net/nr_nodes +.br +/proc/net/rose_nodes +.br +/etc/ax25/axports +.br +/etc/ax25/nrports +.br +/etc/ax25/rsports +.fi +.SH "SEE ALSO" +.BR @@@listen@@@ (1), +.BR mheard (1), +.BR ax25 (4), +.BR netrom (4), +.BR rose (4), +.BR axports (5), +.BR nrports (5), +.BR rsports (5), +.BR axparms (8), +.BR nrparms (8), +.BR rsparms (8). +.SH AUTHORS +.nf +Alexander Tietzel DG6XA +.br +Joerg Reuter DL1BKE +.br +Alan Cox GW4PTS +.br +Jonathan Naylor G4KLX +.br +Steve Henson G6IXS +.fi diff --git a/listen/Makefile.am b/listen/Makefile.am index b47ecde..55a937c 100644 --- a/listen/Makefile.am +++ b/listen/Makefile.am @@ -5,7 +5,24 @@ bin_PROGRAMS = listen man_MANS = listen.1 -EXTRA_DIST = $(man_MANS) +EXTRA_DIST = listen.man +CLEANFILES = listen.1 listen.1.tmp + +listen.1 : listen.man + name_call=$$(echo call | sed -e '$(transform)') \ + name_Call=$$(echo $$name_call | sed -r 's@^(.)@\U\1\E@') && \ + name_CALL=$$(echo $$name_call | sed -r 's@^(.*)@\U\1\E@') && \ + name_listen=$$(echo listen | sed -e '$(transform)') \ + name_Listen=$$(echo $$name_listen | sed -r 's@^(.)@\U\1\E@') && \ + name_LISTEN=$$(echo $$name_listen | sed -r 's@^(.*)@\U\1\E@') &&\ + sed -e "s/@@@call@@@/$$name_call/g" \ + -e "s/@@@Call@@@/$$name_Call/g" \ + -e "s/@@@CALL@@@/$$name_CALL/g" \ + -e "s/@@@listen@@@/$$name_listen/g" \ + -e "s/@@@Listen@@@/$$name_Listen/g" \ + -e "s/@@@LISTEN@@@/$$name_LISTEN/g" \ + listen.man > listen.1.tmp && \ + mv listen.1.tmp listen.1; LDADD = $(AX25_LIB) $(NCURSES_LIB) diff --git a/listen/listen.1 b/listen/listen.1 deleted file mode 100644 index 030b716..0000000 --- a/listen/listen.1 +++ /dev/null @@ -1,91 +0,0 @@ -.TH LISTEN 1 "27 August 1996" Linux "Linux Programmer's Manual" -.SH NAME -listen \- monitor AX.25 traffic -.SH SYNOPSIS -.B listen [-8] [-a] [-c] [-h] [-i] [-p port] [-r] [-t] [-v] -.SH DESCRIPTION -.LP -.B Listen -uses SOCK_PACKET facilities to provide a network monitor of all AX.25 -traffic heard by the system. Since KISS is implicitly promiscuous no -special driver configurations are needed. -.LP -This version displays standard AX.25, PE1CHL extended AX.25, NET/ROM, Rose, ARP, -IP, ICMP, TCP and UDP. It also displays IP, TCP, ICMP, TCP and UDP -encapsulated within NET/ROM frames. The program also displays AX.25 and IP -encapsulated within an IP frame, but see RFC1326 for reasons not to do so. -.LP -.B Listen -makes an attempt at decoding some of the more common routing protocols. RSPF -and RIP (both \(lqnormal\(rq and G8BPQs RIP98) are traced. JNOS style -NET/ROM node polls are also displayed. -.LP -.B Listen -can use colors to make the output more readable. The ncurses library is used -to accomplish this. -.B Color support defaults to being disabled, -and the -.BR -c -parameter is used to enable it. -.SH OPTIONS -.TP 10 -.BI \-8 -Indicates that the terminal is capable of printing 8-bit characters. This -parameter is required for the -i parameter to work. -.TP 10 -.BI \-a -Allow for the monitoring of outgoing frames as well as incoming ones. -.TP 10 -.BI \-c -Enable color support. -.TP 10 -.BI \-h -Dump the data portion of the packet in both hexadecimal and ASCII. The -default is to display data as ASCII only. -.TP 10 -.BI \-i -Map IBM codepage 437 characters 128-158 to their ISO-Latin-1 equivalents. -This is a hack for scandinavian users. This parameter is only valid -when used with the -8 and -c parameters. -.TP 10 -.BI "\-p port" -Monitor only those frames received on a particular port, by default all -AX.25 devices are monitored. -.TP 10 -.BI \-r -Dump the data portion in a "readable" fashion, which is more suitable -for tracing plaintext AX.25 traffic. CR-LF conversion is done. -.TP 10 -.BI \-t -Displays a timestamp with each packet received. -.TP 10 -.BI \-v -Display the version. -.SH FILES -/etc/ax25/axports -.SH "SEE ALSO" -.BR call (1), -.BR mheard (1), -.BR beacon (1), -.BR ax25 (4), -.BR netrom (4), -.BR rose (4), -.BR kissattach (8). -.LP -.SH BUGS -.B Listen -does not validate the checksums of frames that support them (ie IP), -therefore corrupt frames will be displayed with bogus values. The MSS -of a TCP frame that contains that option is not displayed. -.SH AUTHORS -.nf -Alan Cox GW4PTS -.br -Jonathan Naylor G4KLX -.br -Phil Karn KA9Q -.br -Heikki Hannikainen OH7LZB -.br -Scott Miller N1VG -.fi diff --git a/listen/listen.man b/listen/listen.man new file mode 100644 index 0000000..adc8dea --- /dev/null +++ b/listen/listen.man @@ -0,0 +1,91 @@ +.TH @@@LISTEN@@@ 1 "27 August 1996" Linux "Linux Programmer's Manual" +.SH NAME +@@@listen@@@ \- monitor AX.25 traffic +.SH SYNOPSIS +.B @@@listen@@@ [-8] [-a] [-c] [-h] [-i] [-p port] [-r] [-t] [-v] +.SH DESCRIPTION +.LP +.B @@@Listen@@@ +uses SOCK_PACKET facilities to provide a network monitor of all AX.25 +traffic heard by the system. Since KISS is implicitly promiscuous no +special driver configurations are needed. +.LP +This version displays standard AX.25, PE1CHL extended AX.25, NET/ROM, Rose, ARP, +IP, ICMP, TCP and UDP. It also displays IP, TCP, ICMP, TCP and UDP +encapsulated within NET/ROM frames. The program also displays AX.25 and IP +encapsulated within an IP frame, but see RFC1326 for reasons not to do so. +.LP +.B @@@Listen@@@ +makes an attempt at decoding some of the more common routing protocols. RSPF +and RIP (both \(lqnormal\(rq and G8BPQs RIP98) are traced. JNOS style +NET/ROM node polls are also displayed. +.LP +.B @@@Listen@@@ +can use colors to make the output more readable. The ncurses library is used +to accomplish this. +.B Color support defaults to being disabled, +and the +.BR -c +parameter is used to enable it. +.SH OPTIONS +.TP 10 +.BI \-8 +Indicates that the terminal is capable of printing 8-bit characters. This +parameter is required for the -i parameter to work. +.TP 10 +.BI \-a +Allow for the monitoring of outgoing frames as well as incoming ones. +.TP 10 +.BI \-c +Enable color support. +.TP 10 +.BI \-h +Dump the data portion of the packet in both hexadecimal and ASCII. The +default is to display data as ASCII only. +.TP 10 +.BI \-i +Map IBM codepage 437 characters 128-158 to their ISO-Latin-1 equivalents. +This is a hack for scandinavian users. This parameter is only valid +when used with the -8 and -c parameters. +.TP 10 +.BI "\-p port" +Monitor only those frames received on a particular port, by default all +AX.25 devices are monitored. +.TP 10 +.BI \-r +Dump the data portion in a "readable" fashion, which is more suitable +for tracing plaintext AX.25 traffic. CR-LF conversion is done. +.TP 10 +.BI \-t +Displays a timestamp with each packet received. +.TP 10 +.BI \-v +Display the version. +.SH FILES +/etc/ax25/axports +.SH "SEE ALSO" +.BR @@@call@@@ (1), +.BR mheard (1), +.BR beacon (1), +.BR ax25 (4), +.BR netrom (4), +.BR rose (4), +.BR kissattach (8). +.LP +.SH BUGS +.B @@@Listen@@@ +does not validate the checksums of frames that support them (ie IP), +therefore corrupt frames will be displayed with bogus values. The MSS +of a TCP frame that contains that option is not displayed. +.SH AUTHORS +.nf +Alan Cox GW4PTS +.br +Jonathan Naylor G4KLX +.br +Phil Karn KA9Q +.br +Heikki Hannikainen OH7LZB +.br +Scott Miller N1VG +.fi -- cgit v1.2.3