XRPi Changelog
XRPi Downloads
Documentation Index
Alphabetic Index
XRPi Documentation Index
Contents:
About This Documentation
Manual Sections:
0 - Installation & Configuration 1 - Command Reference - All Users 2 - Command Reference - Sysop Only 3 - (to be added) 4 - (to be added) 5 - Protocols 6 - Servers & Application Support 7 - Configuration Directives 8 - Files Used By XRPi 9 - Miscellaneous Topics
See also: Alphabetical Index of Topics
About This Documentation:
This is an HTML version of the XRPi sysop manual pages, which are text-only pages accessible from the XRPi command line using the MAN command (note this dates back to the days of DOS XRouter, so it is not the same as the Linux man pages).
Like XRPi itself, this documentation is a work in progress, and it is far from perfect or complete. 100% accuracy cannot be guaranteed and the navigation is abysmal. But it is better than no documentation.
This documentation is always more up-to-date than the MAN pages supplied with XRPi. We are working to update those at the same time.
As XRPi and XRLin are functionally the same, this documentation serves for both.
Please report errors / omissions or suggest improvements via the XRouter support group at: https://groups.io/g/xrouter, or email vk2dot_[at]tpg.com.au (replace the [at] with @).
Section 0: Installation & Configuration
Getting Started:
Low Level Interfacing Topics:
Interfaces Ports LAN Interfacing KISS Interfacing SLIP - Serial Line Interface Protocol PPP - Point to Point Protocol AGW Packet Engine Interface AXIP - AX25 over IP Interfacing AXUDP - AX25 over UDP Interfacing AXTCP - AX25 over TCP Interfacing KISSTCP - KISS over TCP Interfacing Sound Modem YAM Interfacing Loopback Interface Application Layer Interfacing Topics:
Application Support AGW Application Support WA8DED TNC Emulator TNC2 Emulator TTY Interface Remote Host Protocol (RHP)
Section 1: Command Reference
These are the commands that are available to both users and sysops:
? Command List / Syntax Help @ Request / answer password challenge AMSG Enter APRS Messaging Mode AXROUTES Display AX25 level 2 circuits BYE Disconnect CHAT Connect to chat server CHATCMDS Chat server commands CONNECT Connect to another station DISCARD Start a sink session DX Displays distant APRS stations ECHO Start an Echo session FINGER Display information about users GPING Send GNET Echo Request HELP Displays help for commands and other topics HOST Display information about a TCP/IP host INFO Displays information about the node and other topics IPROUTE Display IP routing table J Displays recently connected stations LINKS Displays the currently active level 2 sessions MAN Display Sysop's Manual pages MHEARD "Monitor Heard" (recently heard callsigns) NODES Display / Modify the Nodes table NPING Send a Netrom echo request NRR Netrom Record Route PING Send ICMP echo request(s) PMS Access the integral PMS PORTS List the available ports QUIT Disconnect from the router ROUTES List Neighbour Routes SEND Send unproto text STATS Display router statistics TELNET Establish a TCP "downlink" TRACERT Trace route to TCP/IP host TTYLINK Chat directly to another TCP/IP station USERS Show who is using XRPi VERSION Display software version and author WX Display APRS Weather Information. XLINK Establish a Temporary SLIP / PPP Interlink YELL Yell for sysop
Section 2: System Maintenance Commands
The following commands are only available to Sysops:
< Execute an XRPi command script ! Run a command or program in an O/S shell *** Temporary Console Callsign Override ARP Display / Edit ARP Table BELL Display / set console bell times CAPTURE Enable / disable tracing to file. CFLAGS Display / Set Connection Control Flags. CMD Add / Delete command aliases. CTRL Read / Write remote hardware control port DATE Enquire / set system date DHCP Display DHCP-obtained IP configuration parameters DIAL Dial a PSTN connection DIGIFLAG Display / Set digipeat options DIGIPORT Display / Set port to digipeat on DNS DNS Configuration Commands DOS Enter DOS Emulator Mode DUN Dial-Up Networking Commands (obsolete) FEC Control Forward Error Correction FTP-CMDS FTP Server Commands FRACK Display / Set FRACK for a port FULLDUP Display / Set full duplex mode GNET Display / Set GNET parameters IDPATH Display / Set destination & digi path for ID beacons IDTEXT Display / Set ID beacon. IP IP Routing Commands IPADDRESS Display / Set IP address(es) IPLINK Display / Set Port IPLINK Address KILL Terminate any session LOADNODES Load the nodes and routes tables from disk LOG Enable / disable activity logging MAXFRAME Display / Set port MAXFRAME value MHCLEAR Clear MHeard list MHFLAGS Display / set port MHFLAGS MINQUAL Display / Set port minimum quality MINTXQUAL Display / Set minimum quality to transmit MMASK Select which protocol(s) to monitor (trace) MONITOR Enable / disable traffic monitoring (tracing) MOTD Maintain "Message Of The Day" MPORT Select which port(s) to monitor (trace) MTO Monitor frames to/from specified destination. NAT Network Address Translation Commands NETMASK Display / Set subnet mask NODESINT Display / Set interval between nodes broadasts NOTIFY Enable / Disable notifications on RLOGIN session PACLEN Display / Set global or port paclen values PERSIST Display / Set the persist value for a port PIPE Display / configure Frame Pipes PIPEFLAG Control frame piping PPP Point to Point Protocol Configuration commands QUALITY Display / Set default quality value for a port REBOOT Reboot machine (Obsolete) RESPTIME Display / Set L2 delayed ack timer for port RESTART Re-start XRPi RETRIES Display / Set the retries parameter for a port RIP Routing Interface Protocol configuration commands ROUTES Add, Drop and List Neighbour Routes SAVENODES Save the nodes and routes tables to disk SHELL Run a command or program in an O/S shell SLOTTIME Display / Set the slottime parameter for a port START Start a daemon process STOP Stop a daemon process / List active daemons TALK Talk to a user TCP TCP status / configuration commands TIME Enquire / Set System Time TSYNC Synchronise Time using Internet Time Server TXDELAY Display / Set the transmit keyup delay for a port TXOK Display / Set "ok to tx" for a port TXPORT Control the port on which to TX TXTAIL Display / Set the transmit keydown delay UDP UDP status and configuration commands UDPLOCAL Display / Set a port's UDPLOCAL parameter UDPREMOTE Display / Set a port's UDPREMOTE parameter UNPROTO Destination and digipeater calls for UI broadcasts DOS Emulator Commands
The following commands are available only in DOS emulation mode:
CD Change Directory COPY Copy File(s) DEL Delete File(s) DF Enquire Disk Free Space DIR Directory of Files EDIT Create / Edit a Text File EXIT Exit DOS Emulator MD Make Directory MOVE Move File(s) REN Rename File(s) RMDIR Remove Directory TYPE Display Text File
Section 5: Protocols
ARP - Address Resolution Protocol AXIP - AX25 over IP Protocol AXUDP - AX25 over UDP Protocol AXTCP - AX25 over TCP Protocol DHCP - Dynamic Host Configuration Protocol INP3 - Internode Protocol IPENCAP Protocol IPIP Protocol IPUDP Protocol KISS KISSTCP - KISS over TCP L3RTT Modulo-128 PPP - Point to Point Protocol RIP - Routing Information Protocol SLIP - Serial Line Interface Protocol
Section 6: Servers (& Application support?)
Servers Overview APRS Server CHAT Server DISCARD Server DNS Server ECHO Server FINGER Server FTP Server HTTP Proxy Server HTTP Server Personal Mail Server (PMS) RLOGIN - Remote Login Server SOCKS Proxy Telnet Proxy Server TCP Server Ports
Section 7: Configuration Directives
(## This section is incomplete!! ##). The following directives may be used in XROUTER.CFG:
APPLMASK Application Connectivity Mask. CFLAGS Connection Control Flags. MAXHOPS Set Hopcount Horizon. MAXTT Set Trip Time Horizon. QUALADJUST NetRom Quality Manipulation ROWS Set Display Height
Section 8: Files Used By XRPi
IMPORTANT! Linux is case sensitive. All XRPi configuration files and directories use UPPER case.
*.SCR Dialler scripts. ACCESS.SYS TCP/IP access control. BOOTCMDS.SYS Boot up config commands. CRONTAB.SYS Event control. DOMAIN.SYS TCP/IP hostname resolution. DYNDNS.CFG Dynamic DNS Configuration. ENCAP.TXT IPENCAP routes. EXEC.HTM Command template for HTTP server HTTP.ACL HTTP Proxy Egress Control. HTTP.SYS HTTP Rewrite / Proxy Control. HTTPBAN.SYS HTTP URL block list. IGATE.CFG APRS IGATE configuration. IPROUTE.SYS IP routes / configuration. PASSWORD.SYS Sysop passwords. PPPHOST.n PPP configuration files. PPPLOG.TXT PPP activity log. SOCKS.ACL SOCKS proxy egress control. TELGUEST.ACL Telnet "guest" mode egress control. TELPROXY.ACL Telnet proxy egress control. TELPROXY.MSG Telnet proxy welcome message. USERPASS.SYS User passwords. XENCAP.TXT Amprnet Encapsulated Routing File. xrpi XRPi executable program. XRNODES NetRom nodes / routes recovery file. XROUTER.CFG XRPi Main Configuration File.
Section 9: Miscellaneous Topics
Automatic Route Quality TCP/IP Stealth Mode APRS TCP Access Control BCAST -- UI Broadcasting Console Colours Dial-Up Networking Dynamic DNS Update Client HELP System IGATE Daemon INFO System IP Country Codes IP Primer IP Stacks L2 Fragmentation L3 Fragmentation MHEARD Permanent Links Frame Pipes Proxies PSTN Time Dependent Routing XRPiMon Monitor Program