Return to pod2mdoc.1 CVS log

Up to [cvsweb.bsd.lv] / pod2mdoc

Annotation of pod2mdoc/pod2mdoc.1, Revision 1.1

1.1     ! schwarze    1: .\"    $Id: pod2mdoc.1,v 1.2 2014/03/19 22:12:13 kristaps Exp $
        !             2: .\"
        !             3: .\" Copyright (c) 2014 Kristaps Dzonsons <kristaps@bsd.lv>
        !             4: .\"
        !             5: .\" Permission to use, copy, modify, and distribute this software for any
        !             6: .\" purpose with or without fee is hereby granted, provided that the above
        !             7: .\" copyright notice and this permission notice appear in all copies.
        !             8: .\"
        !             9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
        !            10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
        !            11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
        !            12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
        !            13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
        !            14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
        !            15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
        !            16: .\"
        !            17: .Dd $Mdocdate: March 19 2014 $
        !            18: .Dt POD2MDOC 1
        !            19: .Os
        !            20: .Sh NAME
        !            21: .Nm pod2mdoc
        !            22: .Nd Convert POD data to mdoc input
        !            23: .Sh SYNOPSIS
        !            24: .Nm pod2man
        !            25: .Op Fl chloqruv
        !            26: .Op Fl d Ar date
        !            27: .Op Fl n Ar title
        !            28: .Op Fl s Ar section
        !            29: .Op Ar file
        !            30: .Sh DESCRIPTION
        !            31: The
        !            32: .Nm
        !            33: utility reads
        !            34: .Ar file
        !            35: and
        !            36: generates
        !            37: .Xr mdoc 7
        !            38: input from
        !            39: .Xr perlpod 1
        !            40: source.
        !            41: If unspecified or
        !            42: .Ar \&- ,
        !            43: .Ar file
        !            44: is taken to be standard input.
        !            45: Its arguments are as follows:
        !            46: .Bl -tag -width Ds
        !            47: .It Fl chloqruv
        !            48: For compatibility with
        !            49: .Xr pod2man 1 .
        !            50: Ignored.
        !            51: .It Fl d Ar date
        !            52: Set the document date
        !            53: .Pq Sq Dd
        !            54: to
        !            55: .Ar date
        !            56: .Po
        !            57: preferrably in
        !            58: .Qq Month Day, Year
        !            59: format
        !            60: .Pc .
        !            61: If unspecified,
        !            62: .Nm
        !            63: uses the file modification date or the current date if reading from
        !            64: standard input.
        !            65: .It Fl n Ar title
        !            66: Set the document title
        !            67: .Pq Sq Dt
        !            68: to
        !            69: .Ar title .
        !            70: If unspecified,
        !            71: .Nm
        !            72: uses the suffix-stripped filename part of
        !            73: .Ar file
        !            74: as a document title or
        !            75: .Ar STDIN
        !            76: if reading from standard input
        !            77: .Pq you probably don't want that .
        !            78: .It Fl s Ar section
        !            79: Set the document section
        !            80: .Pq Sq Dt
        !            81: to
        !            82: .Ar section .
        !            83: If unspecified,
        !            84: .Nm
        !            85: uses
        !            86: .Ar 1
        !            87: or, if the input file suffix is
        !            88: .Li .pm ,
        !            89: uses
        !            90: .Ar 3p .
        !            91: .El
        !            92: .Sh EXIT STATUS
        !            93: .Ex -std
        !            94: .Sh COMPATIBILITY
        !            95: If
        !            96: .Fl s
        !            97: is not specified and the suffix for
        !            98: .Ar file
        !            99: is
        !           100: .Li .pm ,
        !           101: infer a manual section of 3p, not 3.
        !           102: .Sh SEE ALSO
        !           103: .Xr perlpod 1
        !           104: .Xr pod2man 1
        !           105: .Sh AUTHORS
        !           106: .Nm
        !           107: was written by
        !           108: .Ar Kristaps Dzonsons ,
        !           109: .Mt kristaps@bsd.lv .
        !           110: .Sh CAVEATS
        !           111: By way of being a presentational language, POD translates poorly to
        !           112: .Xr mdoc 7 .
        !           113: Semantic content will be necessarily lost.
        !           114: .Pp
        !           115: .Nm
        !           116: does not currently support the following:
        !           117: .Bl -enum
        !           118: .It
        !           119: any sort of link
        !           120: .It
        !           121: escapes that are htmlnames or numbers
        !           122: .It
        !           123: escape codes with alternative delimiters
        !           124: .It
        !           125: probably many other things
        !           126: .El