Pod links to manpages

Discussion in 'Perl Misc' started by Petteri Hintsanen, Jan 16, 2014.

  1. perlpodstyle(1) states:

    "References to other man pages should be in the form
    "manpage(section)" or ""L<manpage(section)>"", and Pod::Man will
    automatically format those appropriately. Both will render as
    manpage(section). The second form, with L<>, is used to request that
    a POD formatter make a link to the man page if possible."

    and

    "Man page references, if they use the standard "name(section)" form,
    don't have to be enclosed in L<> (although it's recommended)"

    However, when using L<> for manpage references, podchecker gives a
    warning. Pod::Checker(3) describes the warning as follows:

    "There is a section detected in the page name of L<...>, e.g.
    "L<passwd(2)>". POD hyperlinks may point to POD documents only.
    Please write "C<passwd(2)>" instead. Some formatters are able to
    expand this to appropriate code."

    This is confusing. What is the recommended form?

    Thanks,
    Petteri.
     
    Petteri Hintsanen, Jan 16, 2014
    #1
    1. Advertising

Want to reply to this thread or ask your own question?

It takes just 2 minutes to sign up (and it's free!). Just click the sign up button to choose a username and then you can ask your own questions on the forum.
Similar Threads
  1. Ajax Chelsea

    Is array of POD still a POD type?

    Ajax Chelsea, Dec 1, 2003, in forum: C++
    Replies:
    1
    Views:
    349
    Ron Natalie
    Dec 1, 2003
  2. aum
    Replies:
    1
    Views:
    276
    Serge Orlov
    May 29, 2006
  3. Chris Henderson

    standard library manpages for v1.8.5

    Chris Henderson, Sep 20, 2007, in forum: Ruby
    Replies:
    1
    Views:
    116
    Stefano Crocco
    Sep 20, 2007
  4. Himanshu Garg
    Replies:
    1
    Views:
    167
    Himanshu Garg
    Sep 21, 2003
  5. Santosh Kumar
    Replies:
    0
    Views:
    180
    Santosh Kumar
    Apr 13, 2013
Loading...

Share This Page