summaryrefslogtreecommitdiffstats
path: root/netrom/nrparms.8
blob: bd42e0e803b001f122cb87151429d7fe796bbf5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
.TH NRPARMS 8 "15 July 2011" Linux "Linux System Managers Manual"
.SH NAME
nrparms \- Configure the NET/ROM interface.
.SH SYNOPSIS
.B nrparms -nodes node +|- ident quality count port neighbour [digicall...]
.LP
.B nrparms -routes port nodecall [digicall...] +|- quality
.LP
.B nrparms -version
.SH DESCRIPTION
.LP
This program is used to manipulate the routing tables of the NET/ROM network
layer, or to get and set many of the network and transport layer parameters
for the NET/ROM protocol. The program has three basic modes of operation,
node setting, neighbour setting and general parameter setting. The syntax
for the node and neighbour setting is taken from the original NET/ROM manual
and is therefore not very UNIXy but should be familiar to those familiar
with NET/ROMs or TheNet.
.LP
To set up a new route to a NET/ROM node in the routing tables you must use
the nodes option. All of the parameters are needed to add the node. It is
probably best to illustrate with an example:
.LP
.B 	nrparms -nodes GB7BPQ + NMCLUS 120 6 vhf G8ROU-3
.LP
This creates a new route to a distant node with the callsign GB7BPQ and the
alias NMCLUS, it has a quality of 120 (out of 255) and has an obsolescence
count of six and packets for that node should be sent on the AX.25 port named
vhf to my immediate neighbour G8ROU-3. The callsigns of the node and the
neighbour may be the same. For example to set up the node G8ROU-3 which is
also my immediate neighbour, I would use:
.LP
.B 	nrparms -nodes G8ROU-3 + MATLCK 200 6 vhf G8ROU-3
.LP
If the ident of the remote node is not known, it is possible to add a
node with a blank ident. To do this an ident of '*' must be entered on
the command line. Because of the command line expansion that shells do, the *
must be escaped by enclosing it in quotes.
.LP
It is also possible to remove a route to a distant node with the same
command except that the + is replaced by a -. The other parameters must also
be present. If the node has not other routes then the node will be deleted,
and the neighbour node that the connections go via may also be deleted if no
other node route uses it, and it is not a locked neighbour entry.
.LP
When setting up a new node, a new neighbour entry may also be created. This
will have a default value. For that neighbour to be meaningful in the
automatic routing process, it must have a more reasonable entry in the
neighbours list. To do this the routes option of the command must be used.
An example:
.LP
.B 	nrparms -routes ax0 G8ROU-3 + 120
.LP
This will create (or update) the neighbour entry for G8ROU-3 with a quality
of 120 and it will be locked, it will not create a node entry for the
neighbour. This quality will be used by the
.BR netromd (8)
program when calculating route qualities via this neighbour. Normally once a
neighbour has zero node routes going via it, it will be deleted. Locking a
neighbour prevents the deletion from occurring. To unlock a neighbour entry,
the same command is used but with the + replaced by a -.
.SH FILES
.LP
/etc/ax25/axports
.br
/etc/ax25/nrports
.SH "SEE ALSO"
.BR call (1),
.BR netrom (4),
.BR nrports (5),
.BR axparms (8),
.BR netromd (8),
.BR nrparms (8).
.SH AUTHOR
Jonathan Naylor G4KLX <g4klx@g4klx.demon.co.uk>