From 9ce46a5c2b63c20bf72303e639ff5ac4103efa25 Mon Sep 17 00:00:00 2001 From: "Jay L. Gao" Date: Thu, 13 Jun 2024 17:49:39 -0700 Subject: [PATCH] update ionstart entry --- gh-pages/docs/ION-Utilities.md | 72 +++++++++++++++++----------------- 1 file changed, 37 insertions(+), 35 deletions(-) diff --git a/gh-pages/docs/ION-Utilities.md b/gh-pages/docs/ION-Utilities.md index b76b7f54d..548be80fe 100644 --- a/gh-pages/docs/ION-Utilities.md +++ b/gh-pages/docs/ION-Utilities.md @@ -22,20 +22,33 @@ The `ionstart` script is typically copied into the `/usr/local/bin` directory us - A set of individual configuration file for each required ION modules, or - A combination of both -ION needs to be launched through a number of administration programs in the proper order: `.rc`, `ionrc`, `ionsecrc`, `bpsecrc`, `ltpsecrc`, `ltprc`, `bprc`, `ipnrc`, `biberc`, `dtn2rc`, `acsrc`, `imcrc`, `bssprc`, and `cfdprc`. - -To instantiate a bare-bone minimal DTN node, only the `ionrc` and the `bprc` configuration files are needed. The remaining modules are optional, depending on the set of features your DTN node is configured to have. - -The `.rc` file is a consolidated file that includes multiple sections, each corresponding to different modules. - -The `ionstart` script automatically parses these files and launches the administrative programs in the right order for you. Here is the usage: - -``` +ION needs to be launched through a number of administration programs in the following order: + +- `.rc` - consolidated file that includes multiple sections, each corresponding to different modules. +- `ionrc` - configures ION working memory and heap allocations and contract graph. +- `ionsecrc` - configures security keys for ION +- `bpsecrc` - configures BPSec +- `ltpsecrc` - configures LTP-level security +- `ltprc` - configures LTP +- `bprc` - configures BPv7 (or BPv6) +- `ipnrc` - configures IPN naming and forwarding +- `biberc` - configures Bundle-in-Bundle encapsulation (BPv7 only) +- `dtn2rc` - configure DTN2 naming and forwarding +- `acsrc` - configures aggregated custody signaling (BPv6 only) +- `imcrc` - configures IMC naming and multicast (BPv6 only) +- `bssprc` - configures Bundle Streaming Service Protocol prototype (deprecated after 4.1.3 but still available) +- `cfdprc` - configures CCSDS File Delivery Protocol implementation in ION + +Please see the man page for each configuration file for detailed information. Currently, the AMS configuration file `.amsrc` are not supported. + +To instantiate a bare-bone minimal DTN node, only the `ionrc` and the `bprc` configuration files are needed. All remaining modules are optional, only needed if the corresponding features applies to the specific DTN node's configuration. The `ionstart` script automatically parses these files and launches the administrative programs in the right order for you. + +```bash IONSTART: Interplanetary Overlay Network startup script USAGE: - ionstart [-I config] [-t tag] [-a acsrc] [-b bprc] [-B bssprc] - [-d dtn2rc] [-e biberc][-i ionrc] [-l ltprc] [-m imcrc] - [-p ipnrc] [-s ionsecrc] [-S bpsecrc] [-L ltpsecrc] [-c cfdprc] + ionstart [-I config] [-t tag] [-a acsrc] [-b bprc ] [-B bssprc] + [-d dtn2rc] [-e biberc][-i ionrc ] [-l ltprc] [-m imcrc] + [-p ipnrc] [-s ionsecrc] [-S bpsecrc] [-L ltpsecrc] [-c cfdprc] Defined configurations will be run in the following order: config, ionrc, ionsecrc, bpsecrc, ltpsecrc ltprc, bprc, ipnrc, biberc, dtn2rc, acsrc, imcrc, bssprc, cfdprc @@ -49,41 +62,30 @@ USAGE: in config file. If unspecified, sections with no tag are used. - -a acsrc Specifies file acsrc to be used to configure acsadmin. - -b bprc Specifies file bprc to be used to configure bpadmin. + -a acsrc Specifies file acsrc to be used to configure acsadmin. (BPv6 only) + -b bprc Specifies file bprc to be used to configure bpadmin with delay. -B bssprc Specifies file bssprc to be used to configure bsspadmin. -d dtn2rc Specifies file dtn2rc to be used to configure dtn2admin. -e biberc Specifies file biberc to be used to configure bibeadmin. - -i ionrc Specifies file ionrc to be used to configure ionadmin. + -i ionrc Specifies file ionrc to be used to configure ionadmin with delay. -l ltprc Specifies file ltprc to be used to configure ltpadmin. - -m imcrc Specifies file imcrc to be used to configure imcdmin. + -m imcrc Specifies file imcrc to be used to configure imcdmin. (BPv6 only) -p ipnrc Specifies file ipnrc to be used to configure ipnadmin. -s ionsecrc Specifies file ionsecrc to be used to configure ionsecadmin. -S bpsecrc Specifies file bpsecrc to be used to configure bpsecadmin. -L ltpsecrc Specifies file ltpsecrc to be used to configure ltpsecadmin. -c cfdprc Specifies file cfdprc to be used to configure cfdpadmin. -``` - -Currently, the AMS configuration file `.amsrc` are not supported by `ionstart`. - -### Launching combined configuration file - -To launch ION using a consolidated configuration file: - -`ionstart -I ` - - - - - - + : optional for -i and -b. Admin program will run these files after initial launch + of non-delayed rc files. If delay is set as 0 explicitly, file will launch + immediately after all non-delayed rc files were executed. +``` -* ionstop -* ionscript -* killm +## ionstop +## ionscript +## killm -### `ionexit` +### ionexit The `ionexit` program shuts down ION with the option to preserve the SDR.