SYNOPSIS formating to prevent filling
[mmh] / man / dp.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .TH DP %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
6 .SH NAME
7 dp \- parse dates 822-style
8 .SH SYNOPSIS
9 .HP 5
10 .na
11 .B %libdir%/dp
12 .RB [ \-form
13 .IR formatfile ]
14 .RB [ \-format
15 .IR string ]
16 .RB [ \-width
17 .IR columns ]
18 .RB [ \-version ]
19 .RB [ \-help ] 
20 .I dates
21 \&...
22 .ad
23 .SH DESCRIPTION
24 .B Dp
25 is a program that parses dates according to the ARPA Internet standard.
26 It also understands many non\-standard formats,
27 such as those produced by TOPS\-20 sites and some UNIX sites using
28 .BR ctime (3).
29 It is useful for seeing how
30 .B nmh
31 will interpret a date.
32 .PP
33 The
34 .B dp
35 program treats each argument as a single date,
36 and prints the date out in the official 822\-format.
37 Hence, it is usually best to enclose each argument in double\-quotes for the
38 shell.
39 .PP
40 To override the output format used by
41 .BR dp ,
42 the
43 .B \-format
44 .I string
45 or
46 .B \-format
47 .I file
48 switches are used.
49 This permits individual fields of the address to be extracted with ease.
50 The string is simply a format string and the file is simply a format file.
51 See
52 .BR mh\-format (5)
53 for the details.
54 .PP
55 Here is the default format string used by
56 .BR dp :
57 .PP
58 .RS 5
59 %<(nodate{text})error: %{text}%|%(putstr(pretty{text}))%>
60 .RE
61 .PP
62 which says that if an error was detected, print the error, a `:',
63 and the date in error.
64 Otherwise, output the 822\-proper format of the date.
65
66 .SH FILES
67 .fc ^ ~
68 .nf
69 .ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
70 ^$HOME/\&.mh\(ruprofile~^The user profile
71 .fi
72
73 .SH "PROFILE COMPONENTS"
74 None
75
76 .SH "SEE ALSO"
77 ap(8),
78 .I "Standard for the Format of ARPA Internet Text Messages"
79 (RFC\-822)
80
81 .SH DEFAULTS
82 .nf
83 .RB ` \-format "' default as described above"
84 .RB ` \-width "' default to the width of the terminal"
85 .fi
86
87 .SH CONTEXT
88 None
89
90 .SH BUGS
91 The argument to the
92 .B \-format
93 switch must be interpreted as a single token by the shell that invokes
94 .BR dp .
95 Therefore, one must usually place the argument to this switch inside double\-quotes.