PROBLEMS(MDOC) MDOC PROBLEMS(MDOC)

NAME

escape/problemsescaping bugs in real-world BSD manuals

QUESTIONS

  1. The SYNOPSIS of the FreeBSD 11 krb5_encrypt(3) manual contains these lines:
    .Ft krb5_error_code 
    .Fo krb5_crypto_overhead 
    .Fa "krb5_context context" 
    .Fa size_t *padsize" 
    .Fc
    What's wrong here? What is the consequence?
  2. The OpenBSD sort(1) manual contains this sentence:
    A line is a record separated from the subsequent record by a 
    newline (default) or NUL \'\\0\' character (-z option).
    Which aspects can be improved here?
  3. The flex(1) manual in the FreeBSD 10.2 release contains the following source code:
    A non-zero macro argument makes rules anchored with 
    '^' active, while a zero argument makes '^' rules inactive.
    What's wrong with that? How should it have been fixed?
    htmlsource
  4. The current manual in FreeBSD 11 now contains the following source code:
    A non-zero macro argument makes rules anchored with 
     '^' active, while a zero argument makes '^' rules inactive.
    What's wrong with the fix?
    htmlsource

HINTS

Introduction: escaping characters

SOLUTION

htmlmdoc
September 29, 2015 bsd.lv