Persistent Links to Man Pages

Creating Persistent Links to Man Pages on docs.sun.com

 This page describes how to determine the unique ID and part number for any man page, in order to craft a persistent link target.

1. Determine the unique identifier (refentry ID) for the page to which you want to link, using the following information:
    The <refentry id> element uniquely identifies a man page. The syntax for the <refentry id> is:

 <refentrytitle>-<manvolnum>

 The <refentrytitle> element contains the name of the man page. It is identical to the filename but does not include the extension that indicates the section number. For example, for the man page file _stack_grow.3c, the <refentrytitle> is _stack_grow.
 The <manvolnum> element contains the section in which the man page resides. By convention, all letters in <manvolnum> are capitalized. For example, for the man page file _stack_grow.3c, the <manvolnum> is 3C.
 Note that only the dot (.) separating the <refentrytitle> from the <manvolnum> is substituted with a hyphen  in the <refentry id>. No other dots appearing in the <refentrytitle> are substituted—they remain as dots.
 The following substitutions are required for special characters that occur in <refentrytitle>:

• Change leading underscore (_) character to u- (the letter "u" followed by hyphen).
• Change all other underscore characters to - (hyphen).
• Change leading plus character  to plus- (the word "plus" followed by hyphen).
• Change all other plus characters  to -plus- (hyphen followed by the word "plus" followed by hyphen).
• Change colon character (:) to - (hyphen).
• Prepend x- (the letter "x" followed by hyphen) to <refentrytitle> that begins with a numeral.

 By convention, the <refentry id> contains no uppercase letters.
 The following table provides examples for the <refentry id>.

2. Determine the part number (PN) of the book in which the man page is published on docs.sun.com (shortname), based on the section.

1. man pages section 1: User Commands (REFMAN1)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN1 Version 13.0//EN
 PN: 819-2239
 sman1 User Commands
 sman1b SunOS/BSD Compatibility Package Commands
 sman1c Communication Commands
 sman1f FMLI Commands
 sman1s SunOS Specific Commands

2. man pages section 1M: System Administration Commands (REFMAN1M)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN1M Version 14.0//EN
 PN: 819-2240
 sman1m System Administration Commands

3. man pages section 2: System Calls (REFMAN2)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN2 Version 13.0//EN
 PN: 819-2241
 sman2 System Calls

4. man pages section 3: Basic Library Functions (REFMAN3A)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN3A Version 12.0//EN
 PN: 819-2243
 sman3c Standard C Library Functions
 sman3c_db Threads Debugging Library Functions
 sman3malloc Memory Allocation Library Functions
 sman3ucb SunOS/BSD Compatibility Library Functions

5. man pages section 3: Networking Library Functions (REFMAN3B)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN3B Version 12.0//EN
 PN: 819-2244
 sman3gss Generic Security Services API Library Functions
 sman3ldap LDAP Library Functions
 sman3nsl Networking Services Library Functions
 sman3resolv Resolver Library Functions
 sman3rpc RPC Library Functions
 sman3sasl Simple Authentication Security Layer Library Functions
 sman3slp Service Location Protocol Library Functions
 sman3socket Sockets Library Functions
 sman3xnet X/Open Networking Services Library Functions

6. man pages section 3: Curses Library Functions (REFMAN3C)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN3C Version 12.0//EN
 PN: 819-2249
 sman3curses Curses Library Functions
 sman3plot Graphics Interface Library Functions
 sman3xcurses X/Open Curses Library Functions

7. man pages section 3: Realtime Library Functions (REFMAN3D)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN3D Version 12.0//EN
 PN: 819-2245
 sman3aio Asynchronous I/O Library Functions
 sman3proc Process Control Library Functions
 sman3rt Realtime Library Functions

8. man pages section 3: Extended Library Functions (REFMAN3E)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN3E Version 12.0//EN
 PN: 819-2246
 sman3bsm Security and Auditing Library Functions
 sman3cfgadm Configuration Administration Library Functions
 sman3contract Contract Management Library Functions
 sman3cpc CPU Performance Counters Library Functions
 sman3dat Direct Access Transport Library Functions
 sman3devid Device ID Library Functions
 sman3devinfo Device Information Library Functions
 sman3elf ELF Library Functions
 sman3exacct Extended Accounting File Access Library Functions
 sman3ext Extended Library Functions
 sman3fstyp File System Type Identification Library Functions
 sman3gen String Pattern-Matching Library Functions
 sman3hbaapi Common Fibre Channel HBA Information Library Functions
 sman3kstat Kernel Statistics Library Functions
 sman3kvm Kernel VM Library Functions
 sman3layout Layout Service Library Functions
 sman3lgrp Locality Group Library Functions
 sman3m Mathematical Library Functions
 sman3mail User Mailbox Library Functions
 sman3mp Multiple Precision Library Functions
 sman3mpapi Common Multipath Management Library Functions
 sman3mvec Vector Math Library Functions
 sman3nvpair Name-value Pair Library Functions
 sman3pam PAM Library Functions
 sman3perl Perl Library Functions
 sman3picl PICL Library Functions
 sman3picltree PICL Plug-In Library Functions
 sman3pool Pool Configuration Manipulation Library Functions
 sman3project Project Database Access Library Functions
 sman3rsm Remote Shared Memory Library Functions
 sman3scf Service Configuration Facility Library Functions
 sman3sec File Access Control Library Functions
 sman3secdb Security Attributes Database Library Functions
 sman3smartcard Smartcard Library Functions
 sman3snmp SNMP Library Functions
 sman3sysevent System Event Library Functions
 sman3tecla Interactive Command-line Input Library Functions
 sman3tnf TNF Library Functions
 sman3uuid Universally Unique Identifier Library Functions
 sman3volmgt Volume Management Library Functions
 sman3wsreg Product Install Registry Library Functions

9. man pages section 3: Library Interfaces and Headers (REFMAN3F)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN3F Version 12.0//EN
 PN: 819-2242
 sman3head Headers
 sman3lib Interface Libraries
 sman3libucb SunOS/BSD Compatibility Interface Libraries

10. man pages section 3: Multimedia Library Functions (REFMAN3G)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN3G Version 2.0//EN
 PN: 819-2250
 sman3mlib:split

11. man pages section 4: File Formats (REFMAN4)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN4 Version 14.0//EN
 PN: 819-2251
 sman4 File Formats
 sman4b SunOS/BSD Compatibility Package File Formats

12. man pages section 5: Standards, Environments, and Macros (REFMAN5)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN5 Version 13.0//EN
 PN: 819-2252
 sman5 Standards, Environments, and Macros

13. man pages section 7: Device and Network Interfaces (REFMAN7)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN7 Version 14.0//EN
 PN: 819-2254 sman7 Device and Network Interfaces
 sman7d Devices
 sman7fs File Systems
 sman7i Ioctl Requests
 sman7ipp IP Quality of Service Modules
 sman7m STREAMS Modules
 sman7p Protocols

14. man pages section 9: DDI and DKI Driver Entry Points (REFMAN9E)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN9E Version 13.0//EN
 PN: 819-2255
 sman9e Driver Entry Points

15. man pages section 9: DDI and DKI Kernel Functions (REFMAN9F)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN9F Version 14.0//EN
 PN: 819-2256
 sman9f Kernel Functions for Drivers

16. man pages section 9: DDI and DKI Properties and Data Structures (REFMAN9S)
 FPI: -//Sun::SunSoft//DOCUMENT REFMAN9S Version 13.0//EN
 PN: 819-2257
 sman9p Kernel Properties for Drivers
 sman9s Data Structures for Drivers

3. Create the link target using the unique identifier and part number
 For example:
 http://docs.sun.com/doc/819-2244/accept-3xnet