tech@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Ingo Schwarze <schwarze@usta.de>
To: tech@mdocml.bsd.lv
Cc: jmc@openbsd.org
Subject: apropos(1) option naming
Date: Sat, 8 Oct 2011 16:29:25 +0200	[thread overview]
Message-ID: <20111008142925.GB28339@iris.usta.de> (raw)

Hi,

i have done some research regarding apropos(1) option naming,
but i'm out of time for drawing conclusions right now.

Yours,
  Ingo

Except that maybe, i still hope for something like

  apropos -s 3 -Q Xr open and Er ENOENT
  apropos -s 4 -Q An Gray or An Reyk

 ----- 8< ----- schnipp ----- >8 ----- 8< ----- schnapp ----- >8 -----

Options, arguments, and environment of the following utilities:
man(1) apropos(1) whatis(1) whereis(1) which(1)

OVERVIEW
========

general agreement:

 -a  all
 -B  binary search path
 -b  search for binaries  
 -C  config file
 -c  copy to stdout
 -d  debug
 -k  keyword search like apropos(1)
 -M  override MANPATH
 -n  use nroff (historic)
 -P  pager
 -T  output device (historic)
 -t  use troff (historic)

agreement for individual programs:

 -f  find like whatis(1) (man)
 -f  end of search path (whereis)
 -m  search for manual pages (whereis)
 -S  subsection (man apropos)
 -S  search path for sources (whereis)
 -s  section (man apropos)
 -s  search for sources (whereis)
 -u  update cache (man) (Linux only)
 -u  search for unusual (whereis)
 -w  where (man)

important clashes:

 -h  SYNOPSIS only (4.3BSD-Net/2 NetBSD OpenBSD)
 -h  help (FreeBSD Linux)
 -m  prepend to MANPATH (man apropos whatis 4.3BSD-Reno NetBSD OpenBSD)
 -m  override MACHINE_ARCH (man FreeBSD)
 -m  another operating system (man apropos whatis Linux)

unimportant clashes:

 -e -l -p -r

used by a single system:

 -D -E -H -I -i -K -L -o -q -R -V -v -W -X -x -Z

completely free:

 -A -F -G -g -J -j -N -O -Q -U -Y -y -z


DETAILED LISTING:
=================

-7 [Linux man] display as pure US-ASCII

-a [OpenBSD man whereis which] display all matching pages
app: 4.3BSD-Tahoe man
app: OpenBSD 2.3 whereis which
[NetBSD man which]
[FreeBSD man whereis which]
[Linux man which]
-a [Linux apropos] logical "and" of keywords

-B path [FreeBSD whereis] path to search for binaries
app: 2BSD whereis
[Linux whereis]

-b [FreeBSD whereis] search for binaries
app: 2BSD whereis
[Linux whereis]

-C file [OpenBSD man apropos whatis] alternate configuration file [man.conf(5)]
app: NetBSD 1.0 man apropos whatis
[NetBSD man apropos whatis]
[Linux man catman apropos whatis]

-c [OpenBSD man] copy to standard output
app: 4.3BSD-Reno man
[NetBSD man]
[Linux man] internal option to be used by catman(1) only

-D [Linux man] reset options to the defaults

-d [FreeBSD man apropos whatis] print debugging information
[Linux man catman whatis]

-E encoding [Linux man] generate specific output character encoding

-e [Version 7 AT&T UNIX man] proprocess by eqn(7)
-e [Linux man] select subsystem (e.g. tcl manuals)
-e [Linux apropos] use exact matches only

-f command [OpenBSD man] synonym for whatis(1)
app: 4BSD man
[FreeBSD man]
[Linux man]
-f [FreeBSD whereis] delimit list of directories after -BMS
app: 2BSD whereis
[Linux whereis]

-H browser [Linux man] produce HTML output

-h [OpenBSD man] display only the SYNOPSIS
app: 4.3BSD-Net/2 man
[NetBSD man]
[FreeBSD man] display short help message
[Linux man catman apropos whatis] like FreeBSD

-I [Linux man] match case when searching for manual pages

-i [Linux man] ignore case when searching for manuals (the default)

-K [Linux man] full text grep over all manuals

-k keyword [POSIX OpenBSD man] synonym for apropos(1)
app: 4BSD man
[NetBSD man]
[FreeBSD man]
[Linux man]

-L [Linux man apropos whatis] force a specific locale

-l [Linux man] local files only, no MANPATH
-l [Linux apropos whatis] do not trim output to terminal width

-M path [OpenBSD man apropos whatis] override MANPATH
app: 4.3BSD man
app: 4.3BSD-Tahoe whatis
app: 4.3BSD-Reno apropos
[NetBSD man apropos whatis]
[Linux man catman apropos whatis]
[FreeBSD man whereis]
app: 2BSD whereis
[Linux whereis]

-m path [OpenBSD man apropos whatis] prepend to MANPATH
app: 4.3BSD-Reno man apropos whatis
[NetBSD man apropos whatis]
[FreeBSD man] override MACHINE_ARCH and MACHINE
-m [FreeBSD whereis] search for manual pages
app: 2BSD whereis
[Linux whereis]
-m system [Linux man apropos whatis] display pages of another operating system

-n [Version 7 AT&T UNIX man] invoke nroff for display on standard output

-o [FreeBSD man] forced use of non-localized pages

-p [NetBSD man] print MANPATH
-p [NetBSD whereis] use PATH
-p [FreeBSD man] use roff preprocessor, override MANROFFSEQ
-p string [Linux man] use specified roff preprocessor

-P [FreeBSD man] override PAGER [more -s]
[Linux man]

-q [FreeBSD whereis] quiet

-R [Linux man] recode

-r [Linux man] change less(1) prompt
-r [Linux apropos whatis] use regular expression matching

-S subsection [OpenBSD man apropos] restrict to architecture
app: OpenBSD 2.3 man
app: OpenBSD 4.5 apropos
[NetBSD man apropos]
[FreeBSD man] restrict to section list, override MANSECT
[Linux man] like FreeBSD
-S path [FreeBSD whereis] path to search for sources
app: 2BSD whereis
[Linux whereis]

-s section [OpenBSD man apropos] restrict to section
app: OpenBSD 2.3 man
app: OpenBSD 4.5 apropos
[NetBSD man apropos]
[Linux apropos whatis]
-s [FreeBSD whereis] search for source files
app: 2BSD whereis
[Linux whereis]
-s [FreeBSD which] silent

-T device [Linux man]
app: somewhere before 4.4 BSD (not sure, would need to check)

-t [FreeBSD man] invoke troff for phototypesetting
app: Version 7 AT&T UNIX man
[Linux man]

-u [FreeBSD whereis] search for unusual entries
app: 2BSD whereis
-u [Linux man] update cache (requires SUID)

-V [Linux man catman apropos whatis] display version information

-v [Linux apropos whatis] verbose warnings

-W [Linux man] list the pathnames of matching formatted pages

-w [OpenBSD man] list the pathnames of the matching pages
app: Version 7 AT&T UNIX man
[NetBSD man]
[FreeBSD man]
[Linux man]
-w [Linux apropos whatis] use shell wildcard matching

-X [Linux man] display using gxditview(1)

-x [FreeBSD whereis] do not use expensive search tools

-Z [Linux man] use a roff postprocessor

keywords ... [OpenBSD apropos] ignoring case, considering parts of words
app: 2BSD apropos
[NetBSD apropos]
[FreeBSD apropos]
[Linux apropos]

name ... [OpenBSD man whatis whereis which] display pages entitled name ...
app: Version 3 AT&T UNIX man: restricted to one name
app: Version 4 AT&T UNIX man: allowing more than one name
app: 2BSD whatis whereis
app: 3BSD which
[NetBSD man whatis whereis which]
[FreeBSD man whatis whereis which]
[Linux man whatis whereis which]

MACHINE [OpenBSD man] restrict to architecture
[NetBSD man]
[FreeBSD man]

MANPAGER [OpenBSD man] alternative manual pagination program [more(1)]

MANPATH [OpenBSD man apropos whatis] manual search path
[NetBSD man apropos whatis]
[FreeBSD man apropos whatis]

PAGER [OpenBSD man] alternative pagination program [more(1)]
[NetBSD man]

PATH [OpenBSD which] command search path
[FreeBSD apropos whatis]

whatis.db [OpenBSD apropos whatis] apropos database file
[NetBSD apropos whatis]

/etc/man.conf [OpenBSD man apropos whatis] default man(1) configuration file
[NetBSD man apropos whatis]
[FreeBSD man]
--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv

             reply	other threads:[~2011-10-08 14:29 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-10-08 14:29 Ingo Schwarze [this message]
2011-10-08 15:13 ` apropos "types" (WAS apropos(1) option naming) Kristaps Dzonsons
2011-10-08 21:01   ` Ingo Schwarze
2011-10-12 21:08     ` Kristaps Dzonsons
2011-10-12 22:53       ` Ingo Schwarze

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20111008142925.GB28339@iris.usta.de \
    --to=schwarze@usta.de \
    --cc=jmc@openbsd.org \
    --cc=tech@mdocml.bsd.lv \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).