← Back to branch summary

~ubuntu-branches/debian/experimental/ion/experimental

« back to all changes in this revision

Viewing changes to dgr/doc/pod1/dgr2file.pod

  • Committer: Package Import Robot
  • Author(s): Leo Iannacone
  • Date: 2012-02-01 09:46:31 UTC
  • Revision ID: package-import@ubuntu.com-20120201094631-qpfwehc1b7ftkjgx
Tags: upstream-2.5.3~dfsg1
Import upstream version 2.5.3~dfsg1

Show diffs side-by-side

added added

removed removed

Lines of Context:
dgr/doc/pod1/dgr2file.pod
 
1
=head1 NAME
 
2
 
 
3
dgr2file - DGR reception test program
 
4
 
 
5
=head1 SYNOPSIS
 
6
 
 
7
B<dgr2file>
 
8
 
 
9
=head1 DESCRIPTION
 
10
 
 
11
B<dgr2file> uses DGR to receive multiple copies of the text of a file
 
12
transmitted by B<file2dgr>, writing each copy of the file to the current
 
13
working directory.  The name of each file written by B<dgr2file> is
 
14
file_copy_I<cycleNbr>, where I<cycleNbr> is initially zero and is increased
 
15
by 1 every time B<dgr2file> closes the file it is currently writing and
 
16
opens a new one.
 
17
 
 
18
Upon receiving a DGR datagram from B<file2dgr>, B<dgr2file> extracts the
 
19
content of the datagram (either a line of text from the file that is being
 
20
transmitted by B<file2dgr> or else an EOF string indicating the end of that
 
21
file).  It appends each extracted line of text to the local copy of that
 
22
file that B<dgr2file> is currently writing.  When the extracted datagram
 
23
content is an EOF string (the ASCII text "*** End of the file ***"),
 
24
B<dgr2file> closes the file it is writing, increments I<cycleNbr>, opens
 
25
a new copy of the file for writing, and prints the message "working on cycle
 
26
I<cycleNbr>."
 
27
 
 
28
B<dgr2file> always receives datagrams at port 2101.
 
29
 
 
30
=head1 EXIT STATUS
 
31
 
 
32
=over 4
 
33
 
 
34
=item 0
 
35
 
 
36
B<dgr2file> has terminated.
 
37
 
 
38
=back
 
39
 
 
40
=head1 FILES
 
41
 
 
42
No configuration files are needed.
 
43
 
 
44
=head1 ENVIRONMENT
 
45
 
 
46
No environment variables apply.
 
47
 
 
48
=head1 DIAGNOSTICS
 
49
 
 
50
=over 4
 
51
 
 
52
=item can't open dgr service
 
53
 
 
54
Operating system error.  Check errtext, correct problem, and rerun.
 
55
 
 
56
=item can't open output file
 
57
 
 
58
Operating system error.  Check errtext, correct problem, and rerun.
 
59
 
 
60
=item dgr_receive failed
 
61
 
 
62
Operating system error.  Check errtext, correct problem, and rerun.
 
63
 
 
64
=item can't write to output file
 
65
 
 
66
Operating system error.  Check errtext, correct problem, and rerun.
 
67
 
 
68
=back
 
69
 
 
70
=head1 BUGS
 
71
 
 
72
Report bugs to <ion-bugs@korgano.eecs.ohiou.edu>
 
73
 
 
74
=head1 SEE ALSO
 
75
 
 
76
file2dgr(1), dgr(3)