.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" 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 >0, 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" 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 "CFDPRC 5" .TH CFDPRC 5 "2016-07-07" "perl v5.24.1" "CFDP configuration files" .\" 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" cfdprc \- CCSDS File Delivery Protocol management commands file .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\s-1CFDP\s0 management commands are passed to \fBcfdpadmin\fR either in a file of text lines or interactively at \fBcfdpadmin\fR's command prompt (:). Commands are interpreted line-by line, with exactly one command per line. The formats and effects of the \s-1CFDP\s0 management commands are described below. .SH "COMMANDS" .IX Header "COMMANDS" .IP "\fB?\fR" 4 .IX Item "?" The \fBhelp\fR command. This will display a listing of the commands and their formats. It is the same as the \fBh\fR command. .IP "\fB#\fR" 4 .IX Item "#" Comment line. Lines beginning with \fB#\fR are not interpreted. .IP "\fBe\fR { 1 | 0 }" 4 .IX Item "e { 1 | 0 }" Echo control. Setting echo to 1 causes all output printed by cfdpadmin to be logged as well as sent to stdout. Setting echo to 0 disables this behavior. .IP "\fBv\fR" 4 .IX Item "v" Version number. Prints out the version of \s-1ION\s0 currently installed. \s-1HINT:\s0 combine with \fBe 1\fR command to log the version number at startup. .IP "\fB1\fR" 4 .IX Item "1" The \fBinitialize\fR command. Until this command is executed, \s-1CFDP\s0 is not in operation on the local \s-1ION\s0 node and most \fIcfdpadmin\fR commands will fail. .IP "\fBi\fR" 4 .IX Item "i" The \fBinfo\fR This command will print information about the current state of the local \s-1CFDP\s0 entity, including the current settings of all parameters that can be managed as described below. .IP "\fBs\fR '\fI\s-1UTS\s0 command\fR'" 4 .IX Item "s 'UTS command'" The \fBstart\fR command. This command starts the UT-layer service task for the local \s-1CFDP\s0 entity. .IP "\fBm discard\fR { 0 | 1 }" 4 .IX Item "m discard { 0 | 1 }" The \fBmanage discard\fR command. This command enables or disables the discarding of partially received files upon cancellation of a file reception. .IP "\fBm requirecrc\fR { 0 | 1 }" 4 .IX Item "m requirecrc { 0 | 1 }" The \fBmanage \s-1CRC\s0 data integrity\fR command. This command enables or disables the attachment of CRCs to all PDUs issued by the local \s-1CFDP\s0 entity. .IP "\fBm fillchar\fR \fIfile_fill_character\fR" 4 .IX Item "m fillchar file_fill_character" The \fBmanage fill character\fR command. This command establishes the fill character to use for the portions of an incoming file that have not yet been received. The fill character is normally expressed in hex, e.g., 0xaa. .IP "\fBm ckperiod\fR \fIcheck_cycle_period\fR" 4 .IX Item "m ckperiod check_cycle_period" The \fBmanage check interval\fR command. This command establishes the number of seconds following reception of the \s-1EOF PDU\s0 \*(-- or following expiration of a prior check cycle \*(-- after which the local \s-1CFDP\s0 will check for completion of a file that is being received. .IP "\fBm maxtimeouts\fR \fIcheck_cycle_limit\fR" 4 .IX Item "m maxtimeouts check_cycle_limit" The \fBmanage check limit\fR command. This command establishes the number of check cycle expirations after which the local \s-1CFDP\s0 entity will invoke the check cycle expiration fault handler upon expiration of a check cycle. .IP "\fBm maxtrnbr\fR \fImax_transaction_number\fR" 4 .IX Item "m maxtrnbr max_transaction_number" The \fBmanage transaction numbers\fR command. This command establishes the largest possible transaction number used by the local \s-1CFDP\s0 entity for file transmission transactions. After this number has been used, the transaction number assigned to the next transaction will be 1. .IP "\fBm segsize\fR \fImax_bytes_per_file_data_segment\fR" 4 .IX Item "m segsize max_bytes_per_file_data_segment" The \fBmanage segment size\fR command. This command establishes the number of bytes of file data in each file data \s-1PDU\s0 transmitted by the local \s-1CFDP\s0 entity in the absence of an application-supplied reader function. .IP "\fBm inactivity\fR \fIinactivity_period\fR" 4 .IX Item "m inactivity inactivity_period" The \fBmanage inactivity period\fR command. This command establishes the number of seconds that a \s-1CFDP\s0 file transfer is allowed to go idle before being canceled for inactivity. The default is one day. .IP "\fBx\fR" 4 .IX Item "x" The \fBstop\fR command. This command stops the UT-layer service task for the local \s-1CFDP\s0 engine. .IP "\fBw\fR { 0 | 1 | }" 4 .IX Item "w { 0 | 1 | }" The \fB\s-1CFDP\s0 watch\fR command. This command enables and disables production of a continuous stream of user-selected \s-1CFDP\s0 activity indication characters. A watch parameter of \*(L"1\*(R" selects all \s-1CFDP\s0 activity indication characters; \*(L"0\*(R" de-selects all \s-1CFDP\s0 activity indication characters; any other \fIactivity_spec\fR such as \*(L"p\*(R" selects all activity indication characters in the string, de-selecting all others. \s-1CFDP\s0 will print each selected activity indication character to \fBstdout\fR every time a processing event of the associated type occurs: .Sp \&\fBp\fR \s-1CFDP PDU\s0 transmitted .Sp \&\fBq\fR \s-1CFDP PDU\s0 received .IP "\fBh\fR" 4 .IX Item "h" The \fBhelp\fR command. This will display a listing of the commands and their formats. It is the same as the \fB?\fR command. .SH "EXAMPLES" .IX Header "EXAMPLES" .IP "m requirecrc 1" 4 .IX Item "m requirecrc 1" Initiates attachment of CRCs to all subsequently issued \s-1CFDP\s0 PDUs. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIcfdpadmin\fR\|(1), \fIbputa\fR\|(1)