TheFloatingLab/NFLpositionUpdater
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Edited the Readme file

Browse Source
This commit is contained in:
Frans Veldman 2025-09-17 07:40:20 +00:00
parent 9c9b45f440
commit 536add3b45
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -29,27 +29,27 @@ You can then test run the program with "perl nfl-apu.pl -?". It should respond w
The program is started from the command line. A few command line options are necessary. The available options are: The program is started from the command line. A few command line options are necessary. The available options are:
### Control options ### Control options
- -h --help Display help - -h --help Display help
- -T --test Debug output - -T --test Debug output
- -d --daemon Run as daemon - -d --daemon Run as daemon
### NMEA connection options ### NMEA connection options
- -t --tcp Use TCP source instead of UDP - -t --tcp Use TCP source instead of UDP
- -g --gpsd Use GPSD source - -g --gpsd Use GPSD source
*The IP address and port of the NMEA stream are given as the final option on the command line. See example below* *The IP address and port of the NMEA stream are given as the final option on the command line. See example below*
### Update options ### Update options
- -x --extended Extended updates (with SOG, COG, DPT) - -x --extended Extended updates (with SOG, COG, DPT)
- -i --interval=<NM> Nautical miles between position updates (default 2). A value 0 means "arrival updates only" - -i --interval=<NM> Nautical miles between position updates (default 2). A value 0 means "arrival updates only"
### Email options ### Email options
- -u --user=<USERNAME> Email account inlog user - -u --user=<USERNAME> Email account inlog user
- -w --password=<PASSWORD> The password associated with the user account - -w --password=<PASSWORD> The password associated with the user account
- -s --server=<ADDRESS> SMTP server - -s --server=<ADDRESS> SMTP server
- -p --port=<PORT> SMTP port (default 587) - -p --port=<PORT> SMTP port (default 587)
- -e --email=<ADDRESS> Source email address - -e --email=<ADDRESS> Source email address
- -o --override=<ADDRESS> Override destination email address (default 'tracking@noforeignland.com') - -o --override=<ADDRESS> Override destination email address (default 'tracking@noforeignland.com')
### Example: ### Example:
perl nfl-apu.pl -t -g -i=2 -x -u=Frans -s=mail.fransveldman.nl -e=noreply@thefloatinglab.world 127.0.0.1:2947 perl nfl-apu.pl -t -g -i=2 -x -u=Frans -s=mail.fransveldman.nl -e=noreply@thefloatinglab.world 127.0.0.1:2947