Updated utility documentation
This commit is contained in:
		
							parent
							
								
									8bbe6ae3ae
								
							
						
					
					
						commit
						943f76804b
					
				
							
								
								
									
										27
									
								
								Changelog.md
									
									
									
									
									
								
							
							
						
						
									
										27
									
								
								Changelog.md
									
									
									
									
									
								
							| @ -1,3 +1,30 @@ | ||||
| ### 2023-09-21: RNS β 0.6.1 | ||||
| 
 | ||||
| This release brings a number of bugfixes, along with useful new mechanisms for ensuring network stability under high, non-constructive and unusual announce load situation. | ||||
| 
 | ||||
| **Changes** | ||||
| - Added announce ingress rate control for new and unknown destinations | ||||
| - Added per-interface announce frequency monitoring to the transport engine | ||||
| - Added per-interface announce burst hold queues | ||||
| - Added announce frequency statistics to `rnstatus` | ||||
| - Added option to sort `rnstatus` output according to various metrics | ||||
| - Added timeout options to `rnprobe` | ||||
| - Added ability to drop all paths via a specific transport instance to `rnpath` | ||||
| - Added new options and features to documentation and manual | ||||
| 
 | ||||
| **Bugfixes** | ||||
| - Fixed announce queue not clearing all announces with exceeded retry limit at the same time | ||||
| - Fixed a bug that caused local packet RSSI and SNR cache to get stuck | ||||
| - Fixed output formatting in `rncp` | ||||
| - Fixed `rnid` not allowing single-aspect destination names | ||||
| - Fixed a number of typos in the documentation | ||||
| 
 | ||||
| **Release Hashes** | ||||
| ``` | ||||
| 461e5cafa7560dcd3ec047141d10f0f48f151c36e1af1d65ec6c65f732cea46a rns-0.6.1-py3-none-any.whl | ||||
| be6a4a6069f2d050e21582f2cf9d3bb59ed4040a0f07761a540bd752d90ea591 rnspure-0.6.1-py3-none-any.whl | ||||
| ``` | ||||
| 
 | ||||
| ### 2023-09-21: RNS β 0.6.0 | ||||
| 
 | ||||
| This release brings a few performance improvements, additions to the included utilities, and fixes a number of bugs. | ||||
|  | ||||
| @ -301,19 +301,23 @@ Filter output to only show some interfaces: | ||||
| 
 | ||||
| .. code:: text | ||||
| 
 | ||||
|   usage: rnstatus.py [-h] [--config CONFIG] [--version] [-a] [-j] [-v] [filter] | ||||
|   usage: rnstatus.py [-h] [--config CONFIG] [--version] [-a] [-A] [-s SORT] | ||||
|                      [-r] [-j] [-v] [filter] | ||||
| 
 | ||||
|   Reticulum Network Stack Status | ||||
| 
 | ||||
|   positional arguments: | ||||
|     filter           only display interfaces with names including filter | ||||
|     filter                only display interfaces with names including filter | ||||
| 
 | ||||
|   options: | ||||
|     -h, --help       show this help message and exit | ||||
|     --config CONFIG  path to alternative Reticulum config directory | ||||
|     --version        show program's version number and exit | ||||
|     -a, --all        show all interfaces | ||||
|     -j, --json       output in JSON format | ||||
|     -h, --help            show this help message and exit | ||||
|     --config CONFIG       path to alternative Reticulum config directory | ||||
|     --version             show program's version number and exit | ||||
|     -a, --all             show all interfaces | ||||
|     -A, --announce-stats  show announce stats | ||||
|     -s SORT, --sort SORT  sort interfaces by [rate, traffic, rx, tx, announces, arx, atx, held] | ||||
|     -r, --reverse         reverse sorting | ||||
|     -j, --json            output in JSON format | ||||
|     -v, --verbose | ||||
| 
 | ||||
| 
 | ||||
| @ -438,7 +442,7 @@ Resolve path to a destination: | ||||
| .. code:: text | ||||
| 
 | ||||
|   usage: rnpath.py [-h] [--config CONFIG] [--version] [-t] [-r] [-d] [-D] | ||||
|                    [-w seconds] [-v] [destination] | ||||
|                    [-x] [-w seconds] [-v] [destination] | ||||
| 
 | ||||
|   Reticulum Path Discovery Utility | ||||
| 
 | ||||
| @ -453,6 +457,7 @@ Resolve path to a destination: | ||||
|     -r, --rates           show announce rate info | ||||
|     -d, --drop            remove the path to a destination | ||||
|     -D, --drop-announces  drop all queued announces | ||||
|     -x, --drop-via        drop all paths via specified transport instance | ||||
|     -w seconds            timeout before giving up | ||||
|     -v, --verbose | ||||
| 
 | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user