OpenLDAP
Up to top level
Build   Contrib   Development   Documentation   Historical   Incoming   Software Bugs   Software Enhancements   Web  

Logged in as guest

Viewing Documentation/6023
Full headers

From: peter
Subject: patch: make man pages more consistent
Compose comment
Download message
State:
0 replies:
0 followups:

Major security issue: yes  no

Notes:

Notification:


Date: Sun, 15 Mar 2009 13:33:21 +0000
From: peter
To: openldap-its@OpenLDAP.org
Subject: patch: make man pages more consistent
Full_Name: Peter Marschall
Version: REL_ENG_2_4
OS: irrelevant
URL: ftp://ftp.openldap.org/incoming/PeterMarschall-090315.diff.gz
Submission from: (NULL) (88.65.218.121)


Hi,

I found the formatting of some man pages of openldap a bit inconsistent.

The patch in ftp://ftp.openldap.org/incoming/PeterMarschall-090315.diff.gz
tries to address these issues. It
* replaces hyphens with minus where appropriate
* makes multi-letter options (e.g. -Z[Z]) or options with optional parameters
  (e.g. -e [!]ext[=value]) display more correctly
* fixes spacing between options and their arguments (where necessary)
* tries to establish a common policy for formatting 
  - literals (e.g. option names): in bold
  - placeholders: in italic
  - optional parts: [ ... ] (brackets in roman font)
  - alternative groups: { ... | ... | ... } (braces and | in roman font)
  This policy has been in place already for lots of the files, but due to
  extensions, changes, ... there have been lots of exceptions

Warning: although the changes are trivial, the patch is quite long.

Please consider these changes for inclusion into the OpenLDAP project.

Regards
PEter
Up to top level
Build   Contrib   Development   Documentation   Historical   Incoming   Software Bugs   Software Enhancements   Web  

Logged in as guest


The OpenLDAP Issue Tracking System uses a hacked version of JitterBug

______________
© Copyright 2009, OpenLDAP Foundation, info@OpenLDAP.org