artemus_cmd.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 artemus - Text substitution tool and much more
   6
   7 =head1 SYNOPSIS
   8
   9  # substitutes text
  10  artemus -i|--input={input file} -o|--output={output file}
  11         [-c|--conf={config file}]
  12         [-p|--paragraph={paragraph_separator}]
  13         [-m|--msdos] [-a|--append]
  14
  15 =head1 DESCRIPTION
  16
  17 B<artemus> is a text substitution tool (thought mainly for preprocessing HTML).
  18 Macros are defined in the file F<artemus.conf>, in the form B<key=value>,
  19 being B<value> the destination text, that can have parameters. The macro is
  20 included in the source file between the B<{-> and B<}> marks. The (possible)
  21 parameters are delimited by the B<|> symbol.
  22
  23 =for html <->
  24
  25 Examples:
  26
  27 In F<artemus.conf> file:
  28
  29  # some simple definitions
  30  Perl=<a href="http://www.perl.com">Perl</a>
  31  LWN=<a href="http://www.lwn.net">Linux Weekly News</a>
  32  separator=<br><hr><br>
  33  head=<html><body bgcolor=ffffff>
  34
  35  # definitions with parameters
  36  # generic link
  37  link=<a href="http://$1">$0</a>
  38  # generic meta
  39  meta=<meta name="$1" content="$0">
  40  # link using the link macro
  41  CPAN={-link|CPAN|www.cpan.org}
  42
  43 In a source file F<index.artemus>:
  44
  45  {-head}
  46  {-meta|links, free software|keywords}
  47  <h1>Links</h1>
  48  <ul>
  49  <li>{-Perl}
  50  <li>{-LWN}
  51  <li>{-CPAN}
  52  <li>{-link|kernel.org|www.kernel.org}
  53  </ul>
  54  {-separator}
  55
  56 By running
  57
  58  artemus -i index.artemus -o index.html
  59
  60 you obtain the file F<index.html>:
  61
  62  <html><body bgcolor=ffffff>
  63  <meta name="keywords" content="links, free software">
  64  <h1>Links</h1>
  65  <ul>
  66  <li><a href="http://www.perl.com">Perl</a>
  67  <li><a href="http://www.lwn.net">Linux Weekly News</a>
  68  <li><a href="http://www.cpan.org">CPAN</a>
  69  <li><a href="http://www.kernel.org">kernel.org</a>
  70  </ul>
  71  <br><hr><br>
  72
  73 The I<--paragraph> argument let us define a string to substitute the empty
  74 lines in the document. If defined as <p>, you can create HTML documents
  75 separating the paragraphs with only a blank line, as B<artemus> will fill
  76 them with <p>.
  77
  78 The I<--msdos> argument creates the typical MSDOS end of line, CR+LF.
  79
  80 The I<--append> argument appends the output to destination file, instead
  81 of overwriting it.
  82
  83 =head1 AUTHOR
  84
  85 (C) Angel Ortega <angel@triptico.com> 2000/2008
  86
  87 =cut