pointtools

Simple point utilities to hold text presentations.
git clone git://r-36.net/pointtools
Log | Files | Refs | README | LICENSE

md2point.1 (1146B)


      1 .Dd $Mdocdate$
      2 .Dt MD2POINT 1
      3 .Os
      4 .Sh NAME
      5 .Nm md2point
      6 .Nd converts markdown into catpoint presentation files
      7 .Sh SYNOPSIS
      8 .Nm
      9 .Sh DESCRIPTION
     10 The
     11 .Nm
     12 utility reads markdown from stdin and writes formatted text files
     13 to the current directory.  The output text files are intended for
     14 use with catpoint.  The output files are named in a consecutive
     15 manner with the title in the file name.
     16 .Sh MARKDOWN FORMAT
     17 Lines beginning with
     18 .Em ##
     19 are treated as slide titles, and serve as delimiters between output
     20 slides.
     21 .Pp
     22 Lines beginning with
     23 .Em %
     24 are treated as comments, and are not reproduced in the output.
     25 .Pp
     26 Lines beginning with
     27 .Em #pause
     28 denote breaks within slides.
     29 .Pp
     30 Lines beginning with
     31 .Em \e
     32 will remove this leading backslash and print the remaining line.
     33 This can be used for escaping all other formatting.
     34 .Pp
     35 Any other text and formatting is reproduced exactly in the output.
     36 .Sh EXIT STATUS
     37 .Nm
     38 exits with 0 on success, and >0 if a a runtime error occurs.
     39 .Sh SEE ALSO
     40 .Xr catpoint
     41 .Xr dir2point
     42 .Sh AUTHORS
     43 .An Anders Damsgaard Aq Mt anders@adamsgaard.dk ,
     44 and
     45 .An Christoph Lohmann Aq Mt 20h@r-36.net
     46 (original implementation).