.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "IONADMIN 1" .TH IONADMIN 1 "2014-07-08" "perl v5.20.1" "ICI executables" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" ionadmin \- ION node administration interface .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBionadmin\fR [ \fIcommands_filename\fR | . ] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBionadmin\fR configures, starts, manages, and stops the \s-1ION\s0 node on the local computer. .PP It configures the node and sets (and reports on) global operational settings for the \s-1DTN\s0 protocol stack on the local computer in response to \s-1ION\s0 configuration commands found in \fIcommands_filename\fR, if provided; if not, \fBionadmin\fR prints a simple prompt (:) so that the user may type commands directly into standard input. If \fIcommands_filename\fR is a period (.), the effect is the same as if a command file containing the single command 'x' were passed to \fBionadmin\fR \*(-- that is, the \s-1ION\s0 node's \fIrfxclock\fR task is stopped. .PP The format of commands for \fIcommands_filename\fR can be queried from \fBionadmin\fR by entering the command 'h' or '?' at the prompt. The commands are documented in \fIionrc\fR\|(5). .PP Note that \fIionadmin\fR always computes a congestion forecast immediately before exiting. The result of this forecast \*(-- maximum projected occupancy of the \s-1DTN\s0 protocol traffic allocation in \s-1ION\s0's \s-1SDR\s0 database \*(-- is retained for application flow control purposes: if maximum projected occupancy is the entire protocol traffic allocation, then a message to this effect is logged and no new bundle origination by any application will be accepted until a subsequent forecast that predicts no congestion is computed. (Congestion forecasts are constrained by \fIhorizon\fR times, which can be established by commands issued to \fIionadmin\fR. One way to re-enable data origination temporarily while long-term traffic imbalances are being addressed is to declare a congestion forecast horizon in the near future, before congestion would occur if no adjustments were made.) .SH "EXIT STATUS" .IX Header "EXIT STATUS" .ie n .IP """0""" 4 .el .IP "``0''" 4 .IX Item "0" Successful completion of \s-1ION\s0 node administration. .SH "EXAMPLES" .IX Header "EXAMPLES" .IP "ionadmin" 4 .IX Item "ionadmin" Enter interactive \s-1ION\s0 configuration command entry mode. .IP "ionadmin host1.ion" 4 .IX Item "ionadmin host1.ion" Execute all configuration commands in \fIhost1.ion\fR, then terminate immediately. .SH "FILES" .IX Header "FILES" Status and diagnostic messages from \fBionadmin\fR and from other software that utilizes the \s-1ION\s0 node are nominally written to a log file in the current working directory within which \fBionadmin\fR was run. The log file is typically named \fBion.log\fR. .PP See also \fIionconfig\fR\|(5) and \fIionrc\fR\|(5). .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" Environment variables \s-1ION_NODE_LIST_DIR\s0 and \s-1ION_NODE_WDNAME\s0 can be used to enable the operation of multiple \s-1ION\s0 nodes on a single workstation computer. See section 2.1.3 of the \s-1ION\s0 Design and Operations Guide for details. .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" \&\fBNote\fR: all \s-1ION\s0 administration utilities expect source file input to be lines of \s-1ASCII\s0 text that are NL-delimited. If you edit the ionrc file on a Windows machine, be sure to \fBuse dos2unix to convert it to Unix text format\fR before presenting it to \fBionadmin\fR. Otherwise \fBionadmin\fR will detect syntax errors and will not function satisfactorily. .PP The following diagnostics may be issued to the log file: .IP "Can't open command file..." 4 .IX Item "Can't open command file..." The \fIcommands_filename\fR specified in the command line doesn't exist. .IP "ionadmin \s-1SDR\s0 definition failed." 4 .IX Item "ionadmin SDR definition failed." A node initialization command was executed, but an \s-1SDR\s0 database already exists for the indicated node. It is likely that an \s-1ION\s0 node is already running on this computer or that destruction of a previously started the previous \s-1ION\s0 node was incomplete. For most \s-1ION\s0 installations, incomplete node destruction can be repaired by (a) killing all \s-1ION\s0 processes that are still running and then (b) using \fBipcrm\fR to remove all SVr4 \s-1IPC\s0 objects owned by \s-1ION.\s0 .IP "ionadmin can't get \s-1SDR\s0 parms." 4 .IX Item "ionadmin can't get SDR parms." A node initialization command was executed, but the \fIion_config_filename\fR passed to that command contains improperly formatted commands. Please see \&\fIionconfig\fR\|(5) for further details. .PP Various errors that don't cause \fBionadmin\fR to fail but are noted in the log file may be caused by improperly formatted commands given at the prompt or in the \fIcommands_filename\fR. Please see \fIionrc\fR\|(5) for details. .SH "BUGS" .IX Header "BUGS" If the \fIion_config_filename\fR parameter passed to a node initialization command refers to a nonexistent filename, then \fBionadmin\fR uses default values are used rather than reporting an error in the command line argument. .PP Report bugs to .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIionrc\fR\|(5), \fIionconfig\fR\|(5)