From fbb41991bd530270b0f70a110af507fc029e76b8 Mon Sep 17 00:00:00 2001 From: Ralf Baechle Date: Wed, 2 Apr 2008 13:34:05 +0000 Subject: From Matti Aarnio (oh2mqk@sral.fi): * axconfig.c: Find all running network ports, and compare them against the /etc/ax25/axports file. * nrconfig.c: Find all running network ports, and compare them against the /etc/ax25/nrports file. * rsconfig.c: Find all running network ports, and compare them against the /etc/ax25/rsports file. * Update man pages --- ax25.3 | 99 ++++++++++++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 67 insertions(+), 32 deletions(-) (limited to 'ax25.3') diff --git a/ax25.3 b/ax25.3 index 526c33d..795adf8 100644 --- a/ax25.3 +++ b/ax25.3 @@ -1,57 +1,92 @@ -.TH INET 3 "20 April 1999" "Linux" "Linux Programmer's Manual" +.TH INET 3 "2008-Feb-04" "Linux" "Linux Programmer's Manual" .SH NAME -ax25_aton, ax25_aton_entry, ax25_aton_arglist, -ax25_ntoa, ax25_cmp, ax25_validate \- AX25 Address manipulation routines +.B ax25_aton, ax25_aton_entry, ax25_aton_arglist, +.B ax25_ntoa, ax25_cmp, ax25_validate +\- AX25 Address manipulation routines .SH SYNOPSIS .nf .B #include -.sp +.PP .BI "int ax25_aton(const char *" cp ", struct full_sockaddr_ax25 *" fsap ");" -.sp +.PP .BI "int ax25_aton_arglist(const char **" cp ", struct full_sockaddr_ax25 *" fsap ");" -.sp +.PP .BI "int ax25_aton_entry(const char *" cp ", char *" axp ");" -.sp +.PP .BI "char *ax25_ntoa(ax25_address *" axp ");" -.sp +.PP .BI "int ax25_cmp(ax25_address *" ax1 ", ax25_address *" ax2 ");" -.sp +.PP .BI "int ax25_validate(char *" axp ");" -.sp +.PP .BI "char *ax25_config_file(const char *filename);" .fi + .SH DESCRIPTION -\fBax25_aton()\fP takes the ASCII string \fIcp\FP that is in the format -\fIcallsign\fR [[\fIV\fR|\fIVIA\fR] \fIcallsign\fR ...] -and stores it in \fIfsap\fP in network format. +.BR ax25_aton () +takes the ASCII string +.I cp +that is in the format +.I callsign +.RI [[ V | VIA ] callsign "...]" +and stores it in +.I fsap +in network format. .PP -\fBax25_aton_entry()\fP takes the ASCII string of a callsign \fIcp\fP -and stores it in network format in \fIaxp\fP. +.BR ax25_aton_entry () +takes the ASCII string of a callsign +.I cp +and stores it in network format in +.I axp. .PP -\fBax25_aton_arglist()\fP takes a NULL terminated array of strings \fIcp\fP -and stores it \fIfsap\fP in network format. +The +.BR ax25_aton_arglist () +takes a NULL terminated array of strings +.I cp +and stores it in +.I fsap +in network format. .PP -\fBax25_ntoa()\fP takes a network format address \fIaxp\fP and returns the -ASCII representation. The string is returned in a statically allocated -buffer, which subsequent calls will overwrite. +The +.BR ax25_ntoa () +takes a network format address +.I axp +and returns the ASCII representation. +The string is returned in a statically allocated buffer, which +subsequent calls will overwrite. .PP -The \fBax25_cmp()\fP function compares the two ax25 addresses, \fIax1\fP -and \fIax2\fP, that are in network format and determines wether they -are identical, differ only by their SSIDs or are different. +The +.BR ax25_cmp () +function compares the two ax25 addresses, +.I ax1 +and +.IR ax2 , +that are in network format and determines wether they are identical, +differ only by their SSIDs or are different. .PP -The \fBax25_validate\fP function checks to see if the address \fIaxp\fP +The +.BR ax25_validate () +function checks to see if the address +.I axp in network format is a correctly formatted address. .SH "RETURN VALUE" -The \fBax25_aton()\fP and \fBax25_aton_arglist()\fP functions return -1 if -an error occurs otherwise the length of the returned structure. +The +.BR ax25_aton () and +.BR ax25_aton_arglist () +functions return -1 if an error occurs otherwise the length of +the returned structure. .PP -The \fBax25_aton_entry()\fP function returns -1 if an error occurs otherwise -zero. +The +.BR ax25_aton_entry () +function returns -1 if an error occurs otherwise zero. .PP -The \fBax25_cmp()\fP function returns 0 if the two addresses are identical, -1 if they are different or 2 is only the SSIDs are different. +The +.BR ax25_cmp () +function returns 0 if the two addresses are identical, 1 if they are +different or 2 is only the SSIDs are different. .PP -The \fBax25_validate\fP function returns TRUE if the callsign is valid or -FALSE if it is not. +The +.BR ax25_validate () +function returns TRUE if the callsign is valid or FALSE if it is not. .SH "SEE ALSO" .BR ax25 "(4), " netrom "(4), " rose "(4)" -- cgit v1.2.3