From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from danbala.ifoer.tuwien.ac.at (danbala.ifoer.tuwien.ac.at [128.130.168.64]) by krisdoz.my.domain (8.14.5/8.14.5) with ESMTP id s33CHeoY021248 for ; Thu, 3 Apr 2014 08:17:40 -0400 (EDT) Received: by danbala.ifoer.tuwien.ac.at (Postfix, from userid 116) id 4D860390195; Thu, 3 Apr 2014 14:17:38 +0200 (CEST) Date: Thu, 3 Apr 2014 14:17:38 +0200 From: Thomas Klausner To: discuss@mdocml.bsd.lv Subject: Re: pod2mdoc, docbook2mdoc Message-ID: <20140403121738.GA6386@danbala.tuwien.ac.at> References: <533943B9.5080901@bsd.lv> <20140331161315.GC31866@iris.usta.de> <5339C49A.7020502@bsd.lv> <20140331205736.GJ31866@iris.usta.de> <20140331213020.GD29643@danbala.tuwien.ac.at> <5339E423.9010007@bsd.lv> <20140331222118.GB15415@iris.usta.de> <20140331223147.GA17640@danbala.tuwien.ac.at> <533D4DE1.4030304@bsd.lv> X-Mailinglist: mdocml-discuss Reply-To: discuss@mdocml.bsd.lv MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <533D4DE1.4030304@bsd.lv> Hi Kristaps! On Thu, Apr 03, 2014 at 02:02:41PM +0200, Kristaps Dzonsons wrote: > I suggest you check out the latest version... run as: > > pod2mdoc foo.pm | mandoc > > The output is much nicer than pod2man in the same way. Lots more semantic > content as mentioned in the "Smarts" subsection of the manual. Most > visibly, since the SYNOPSIS is now rendered with Nm, Oo/Oc, Ar, and Fl, > mandoc can properly format sections. Thanks. I've tried DSA_SIG_new.pod, basically at random. Here's the output: .Dd July 20, 2009 .Dt DSA_SIG_NEW 1 .Os .Sh NAME .Nm DSA_SIG_new , .Nm DSA_SIG_free .Nd allocate and free DSA signature objects .Sh SYNOPSIS .Bd -literal #include .Ed .Bd -literal DSA_SIG *DSA_SIG_new(void); .Ed .Bd -literal void DSA_SIG_free(DSA_SIG *a); .Ed .Sh DESCRIPTION DSA_SIG_new() allocates and initializes a .Sy DSA_SIG structure. .Pp DSA_SIG_free() frees the .Sy DSA_SIG structure and its components. The values are erased before the memory is returned to the system. .Sh RETURN VALUES If the allocation fails, DSA_SIG_new() returns .Sy NULL and sets an error code that can be obtained by .Xr ERR_get_error 3 Ns . Otherwise it returns a pointer to the newly allocated structure. .Pp DSA_SIG_free() returns no value. .Sh SEE ALSO .Xr dsa 3 Ns , .Xr ERR_get_error 3 Ns , .Xr DSA_do_sign 3 .Sh HISTORY DSA_SIG_new() and DSA_SIG_free() were added in OpenSSL 0.9.3. It's already quite nice! Some suggestions: * foo() -> .Fn foo * too many Ns before punctuation * section number is 1 instead of 3 (not sure how to detect that) * .Bd -literal + #include + Ed -> .In foo * splitting up the functions in the SYNOPSIS the same way is probably too much effort? Related question: How do people use Sy vs. Dv? I personally always mark up NULL as a Dv and similarly for most other defined C symbols. Thanks, Thomas -- To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv