Text written within `*asterisks*` will get shown using italics. Text within
two `**asterisks**` will get shown using bold.
+Text that is prefixed with a space will be treated like an "example" and will
+be output in monospace.
+
## Header and footer
`page-header` is the file that will be output before the generated options
Here is an example of a header file contents:
# This file contain two headers.
-.br
X-header-1: this is a header
# The following header is folded.
-.br
X-header-2: this is
-.br
another header
-
To support sending multipart mail messages, the syntax is extended as follows:
.br
- name can be omitted: the equal sign is the first character of the argument,
text file:
curl -F '=(;type=multipart/alternative' \\
-.br
- -F '=plain text message' \\
-.br
- -F '= <body>HTML message</body>;type=text/html' \\
-.br
+ -F '=plain text message' \\
+ -F '= <body>HTML message</body>;type=text/html' \\
-F '=)' -F '=@textfile.txt' ... smtp://example.com
Data can be encoded for transfer using encoder=. Available encodings are
base64 attached file:
curl -F '=text message;encoder=quoted-printable' \\
-.br
-F '=@localfile;encoder=base64' ... smtp://example.com
See further examples and details in the MANUAL.
sub printdesc {
my @desc = @_;
+ my $exam = 0;
for my $d (@desc) {
if($d =~ /\(Added in ([0-9.]+)\)/i) {
my $ver = $1;
# *italics*
$d =~ s/\*([^ ]*)\*/\\fI$1\\fP/g;
}
+ if(!$exam && ($d =~ /^ /)) {
+ # start of example
+ $exam = 1;
+ print ".nf\n"; # no-fill
+ }
+ elsif($exam && ($d !~ /^ /)) {
+ # end of example
+ $exam = 0;
+ print ".fi\n"; # fill-in
+ }
# skip lines starting with space (examples)
if($d =~ /^[^ ]/) {
for my $k (keys %optlong) {
projects / thirdparty / curl.git / commitdiff
