=================================================================== RCS file: /cvs/pod2mdoc/pod2mdoc.1,v retrieving revision 1.3 retrieving revision 1.5 diff -u -p -r1.3 -r1.5 --- pod2mdoc/pod2mdoc.1 2014/03/23 13:00:24 1.3 +++ pod2mdoc/pod2mdoc.1 2014/03/24 01:07:30 1.5 @@ -1,4 +1,4 @@ -.\" $Id: pod2mdoc.1,v 1.3 2014/03/23 13:00:24 kristaps Exp $ +.\" $Id: pod2mdoc.1,v 1.5 2014/03/24 01:07:30 kristaps Exp $ .\" .\" Copyright (c) 2014 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 23 2014 $ +.Dd $Mdocdate: March 24 2014 $ .Dt POD2MDOC 1 .Os .Sh NAME @@ -98,9 +98,27 @@ is not specified and the suffix for .Ar file is .Li .pm , -infer a manual section of 3p, not 3. +.Nm +infers a manual section of 3p, not 3, as stipulated in +.Xr perlpod 1 . +Furthermore, all links in the format of +.Li L +are assumed to be in section 3p. +.Pp +If +.Nm +encounters an +.Li =item +without the necessary +.Li =over , +it will pretend that a prior +.Li =over +was invoked. +However, it will do so silently and not, as +.Xr pod2man 1 +does, append a POD ERRORS section in the output manpage saying so. .Sh SEE ALSO -.Xr perlpod 1 +.Xr perlpod 1 , .Xr pod2man 1 .Sh AUTHORS .Nm @@ -108,15 +126,30 @@ was written by .Ar Kristaps Dzonsons , .Mt kristaps@bsd.lv . .Sh CAVEATS -By way of being a presentational language, POD translates poorly to +By way of being a presentational language, POD is not well-represented +by .Xr mdoc 7 . Semantic content will be necessarily lost. .Pp .Nm -does not currently support the following: -.Bl -enum -.It -escapes that are htmlnames or numbers -.It -probably many other things -.El +only supports the named +.Li E +escapes. +HTML names and numbers are silently discarded. +.Pp +Although most white-space requests in character encodings are properly +carried to output, adjacent character escapes with the specific +whitespace sequence +.Qq Li "B<2>B< 3>" +will cause the second space to be lost. +.Pp +The +.Li S<> +escape is discarded. +.Pp +Lastly, only the +.Li L +and +.Li L +links are understood and properly rendered as +.Sq \&Xr .