LinuxQuestions.org
Share your knowledge at the LQ Wiki.
Go Back   LinuxQuestions.org > Forums > Linux Forums > Linux - Newbie
User Name
Password
Linux - Newbie This Linux forum is for members that are new to Linux.
Just starting out and have a question? If it is not in the man pages or the how-to's this is the place!

Notices


Reply
  Search this Thread
Old 05-22-2017, 03:56 PM   #1
justmy2cents
Member
 
Registered: May 2017
Location: U.S.
Distribution: Un*x
Posts: 237
Blog Entries: 2

Rep: Reputation: Disabled
Is /usr/share/doc the only place there's documentation?


I just wanted to make sure (so I don't miss anything) that /usr/share/doc is the only place where package specific documentation resides.. Thank You!

Last edited by justmy2cents; 05-22-2017 at 04:44 PM.
 
Old 05-22-2017, 04:14 PM   #2
hydrurga
LQ Guru
 
Registered: Nov 2008
Location: Pictland
Distribution: Linux Mint 20 MATE
Posts: 8,048
Blog Entries: 5

Rep: Reputation: 2918Reputation: 2918Reputation: 2918Reputation: 2918Reputation: 2918Reputation: 2918Reputation: 2918Reputation: 2918Reputation: 2918Reputation: 2918Reputation: 2918
/usr/share/man

/usr/share/info

I would class both man and info files as documentation.
 
1 members found this post helpful.
Old 05-22-2017, 05:27 PM   #3
Habitual
LQ Veteran
 
Registered: Jan 2011
Location: Abingdon, VA
Distribution: Catalina
Posts: 9,374
Blog Entries: 37

Rep: Reputation: Disabled
Quote:
Originally Posted by justmy2cents View Post
I just wanted to make sure (so I don't miss anything) that /usr/share/doc is the only place where package specific documentation resides.. Thank You!
That's the second place I look.

See
Code:
man hier
also.
 
Old 05-22-2017, 10:14 PM   #4
justmy2cents
Member
 
Registered: May 2017
Location: U.S.
Distribution: Un*x
Posts: 237

Original Poster
Blog Entries: 2

Rep: Reputation: Disabled
Wink

Quote:
Originally Posted by hydrurga View Post
/usr/share/man

/usr/share/info

I would class both man and info files as documentation.
I knew about man but not info thanks (but who uses info anyway?)
 
Old 05-22-2017, 10:14 PM   #5
justmy2cents
Member
 
Registered: May 2017
Location: U.S.
Distribution: Un*x
Posts: 237

Original Poster
Blog Entries: 2

Rep: Reputation: Disabled
Quote:
Originally Posted by Habitual View Post
That's the second place I look.

See
Code:
man hier
also.
Thanks dude!
 
Old 05-23-2017, 10:58 AM   #6
ondoho
LQ Addict
 
Registered: Dec 2013
Posts: 17,426
Blog Entries: 10

Rep: Reputation: 5249Reputation: 5249Reputation: 5249Reputation: 5249Reputation: 5249Reputation: 5249Reputation: 5249Reputation: 5249Reputation: 5249Reputation: 5249Reputation: 5249
in my experience it can be all over the place.
if i don't find it with 'man ...', i usually look at the files the package installed, on debian systems with 'dpkg -L <package>', and see what is there... a readme, or html documentation etc.
 
Old 05-23-2017, 11:15 AM   #7
Habitual
LQ Veteran
 
Registered: Jan 2011
Location: Abingdon, VA
Distribution: Catalina
Posts: 9,374
Blog Entries: 37

Rep: Reputation: Disabled
Quote:
Originally Posted by justmy2cents View Post
Thanks
Welcome dude!
 
Old 05-23-2017, 11:45 AM   #8
justmy2cents
Member
 
Registered: May 2017
Location: U.S.
Distribution: Un*x
Posts: 237

Original Poster
Blog Entries: 2

Rep: Reputation: Disabled
Cool

Quote:
Originally Posted by ondoho View Post
in my experience it can be all over the place.
if i don't find it with 'man ...', i usually look at the files the package installed, on debian systems with 'dpkg -L <package>', and see what is there... a readme, or html documentation etc.
Thanks actually a good idea thanks bro man.
 
Old 05-23-2017, 11:47 PM   #9
AwesomeMachine
LQ Guru
 
Registered: Jan 2005
Location: USA and Italy
Distribution: Debian testing/sid; OpenSuSE; Fedora; Mint
Posts: 5,513

Rep: Reputation: 1010Reputation: 1010Reputation: 1010Reputation: 1010Reputation: 1010Reputation: 1010Reputation: 1010Reputation: 1010
Documentation, like gold, is where you find it. Apropos is a good program for searching documentation. For instance:
Code:
$ apropos find
yields this on my laptop:
Code:
$ 

__dev_get_by_flags (9) - find any device with given flags

__dev_get_by_index (9) - find a device by its ifindex

__dev_get_by_name (9) - find a device by its name

__ffs (9)            - find first set bit in word

__scsi_device_lookup (9) - find a device given the host (UNLOCKED)

__scsi_device_lookup_by_target (9) - find a device given the target (UNLOCKED)

ata_dev_phys_link (9) - find physical link for a device

ata_scsi_find_dev (9) - lookup ata_device from scsi_cmnd

ata_timing_cycle2mode (9) - find xfer mode for the specified cycle duration

ata_xfer_mask2mode (9) - Find matching XFER_* for the given xfer_mask

ata_xfer_mode2mask (9) - Find matching xfer_mask for XFER_*

ata_xfer_mode2shift (9) - Find matching xfer_shift for XFER_*

bitmap_find_free_region (9) - find a contiguous aligned mem region

bitmap_find_next_zero_area_off (9) - find a contiguous aligned zero area

bitmap_ord_to_pos (9) - find position of n-th set bit in bitmap

bitmap_pos_to_ord (9) - find ordinal of set bit at given position in bitmap

blk_queue_find_tag (9) - find a request by its tag and queue

blk_queue_start_tag (9) - find a free tag and assign it

bmap (9)             - find a block number in a file

bus_find_device (9)  - device iterator for locating a particular device.

bus_find_device_by_name (9) - device iterator for locating a particular device of a specific name

cfg80211_find_ie (9) - find information element in data

class_find_device (9) - device iterator for locating a particular device

cpupri_find (9)      - find the best (lowest-pri) CPU in the system

d_find_any_alias (9) - find any alias for a given inode

d_obtain_alias (9)   - find or allocate a DISCONNECTED dentry for a given inode

d_obtain_root (9)    - find or allocate a dentry for a given inode

dev_get_by_index (9) - find a device by its ifindex

dev_get_by_index_rcu (9) - find a device by its ifindex

dev_get_by_name (9)  - find a device by its name

dev_get_by_name_rcu (9) - find a device by its name

dev_getbyhwaddr_rcu (9) - find a device by its hardware address

device_find_child (9) - device iterator for locating a particular device.

devres_destroy (9)   - Find a device resource and destroy it

devres_find (9)      - Find device resource

devres_get (9)       - Find devres, if non-existent, add one atomically

devres_release (9)   - Find a device resource and destroy it, calling release

devres_remove (9)    - Find a device resource and remove it

dmi_find_device (9)  - find onboard device by type/name

dmi_first_match (9)  - find dmi_system_id structure matching system DMI data

driver_find (9)      - locate driver on a bus by its name.

driver_find_device (9) - device iterator for locating a particular device.

drm_connector_index (9) - find the index of a registered connector

drm_crtc_index (9)   - find the index of a registered CRTC

drm_crtc_mask (9)    - find the mask of a registered CRTC

drm_dp_find_vcpi_slots (9) - find slots for this PBN value

drm_mode_object_find (9) - look up a drm object with static lifetime

drm_modeset_legacy_acquire_ctx (9) - find acquire ctx for legacy ioctls

drm_plane_index (9)  - find the index of a registered plane

drm_vma_offset_lookup (9) - Find node in offset space

drm_vma_offset_lookup_locked (9) - Find node in offset space

edd_get_pci_dev (9)  - finds pci_dev that matches edev

fb_find_best_mode (9) - find best matching videomode

fb_find_mode (9)     - finds a valid video mode

fb_find_nearest_mode (9) - find closest videomode

fb_match_mode (9)    - find a videomode which exactly matches the timings in var

ffs (9)              - find first set bit in word

ffz (9)              - find first zero bit in word

find_busiest_group (9) - Returns the busiest group within the sched_domain if there is an 

imbalance. If there isn't an imbalance, and the us...

find_get_entry (9)   - find and get a page cache entry

find_get_pages_contig (9) - gang contiguous pagecache lookup

find_get_pages_tag (9) - find and return pages that match tag

find_inode_nowait (9) - find an inode in the inode cache

find_lock_entry (9)  - locate, pin and lock a page cache entry

find_min_pfn_with_active_regions (9) - Find the minimum PFN registered

find_next_best_node (9) - find the next node that should appear in a given node's fallback list

fls (9)              - find last set bit in word

fls64 (9)            - find last set bit in a 64-bit word

ieee80211_bss_get_ie (9) - find IE with given ID

ieee80211_find_sta (9) - find a station

ieee80211_find_sta_by_ifaddr (9) - find a station on hardware

init_rs (9)          - Find a matching or allocate a new rs control structure

init_rs_non_canonical (9) - Find a matching or allocate a new rs control structure, for fields with 

non-canonical representation

ipc_findkey (9)      - find a key in an ipc identifier set

iscsi_find_flashnode_conn (9) - finds flashnode connection entry

iscsi_find_flashnode_sess (9) - finds flashnode session entry

lookup_resource (9)  - find an existing resource by a resource start address

mac_find_mode (9)    - find a video mode

memchr (9)           - Find a character in an area of memory.

memchr_inv (9)       - Find an unmatching character in an area of memory.

memscan (9)          - Find a character in an area of memory.

mpt_findImVolumes (9) - Identify IDs of hidden disks and RAID Volumes

nand_scan_bbt (9)    - [NAND Interface] scan, find, read and maybe create bad block table(s)

of_find_mipi_dsi_device_by_node (9) - find the MIPI DSI device matching a device tree node

of_mdio_find_bus (9) - Given an mii_bus node, find the mii_bus.

page_cache_next_hole (9) - find the next hole (not-present entry)

page_cache_prev_hole (9) - find the prev hole (not-present entry)

pagecache_get_page (9) - find and get a page reference

parent_len (9)       - find the length of the parent portion of a pathname

parport_find_base (9) - find a parallel port by base address

parport_find_number (9) - find a parallel port by number

parport_open (9)     - find a device by canonical device number

pci_bus_find_capability (9) - query for devices' capabilities

pci_find_bus (9)     - locate PCI bus from a given domain and bus number

pci_find_capability (9) - query for devices' capabilities

pci_find_ext_capability (9) - Find an extended capability

pci_find_ht_capability (9) - query a device's Hypertransport capabilities

pci_find_next_bus (9) - begin or continue searching for a PCI bus

pci_find_next_ext_capability (9) - Find an extended capability

pci_find_next_ht_capability (9) - query a device's Hypertransport capabilities

pci_find_parent_resource (9) - return resource region of parent bus of given region

phy_find_first (9)   - finds the first PHY device on the bus

phy_find_setting (9) - find a PHY settings array entry that matches speed & duplex

phy_find_valid (9)   - find a PHY setting that matches the requested features mask

relay_file_read_start_pos (9) - find the first available byte to read

rio_find_mport (9)   - find RIO mport by its ID

rpc_find_or_alloc_pipe_dir_object (9) - (unknown subject)

scsi_alloc_target (9) - allocate a new or find an existing target

scsi_device_lookup (9) - find a device given the host

scsi_device_lookup_by_target (9) - find a device given the target

scsi_kmap_atomic_sg (9) - find and atomically map an sg-elemnt

scsi_report_opcode (9) - Find out if a given command opcode is supported

scsi_sense_desc_find (9) - search for a given descriptor type in descriptor sense data format.

sget (9)             - find or create a superblock

sh64_next_free_dtlb_entry (9) - Find the next available DTLB entry

skb_find_text (9)    - Find a text pattern in skb data

snd_ctl_find_id (9)  - find the control instance with the given id

snd_ctl_find_numid (9) - find the control instance with the given number-id

strchr (9)           - Find the first occurrence of a character in a string

strchrnul (9)        - Find and return a character in a string, or end of string

strlen (9)           - Find the length of a string

strnchr (9)          - Find a character in a length limited string

strnlen (9)          - Find the length of a length-limited string

strnstr (9)          - Find the first substring in a length-limited string

strpbrk (9)          - Find the first occurrence of a set of characters

strrchr (9)          - Find the last occurrence of a character in a string

strstr (9)           - Find the first substring in a NUL terminated string

subsys_find_device_by_id (9) - find a device with a specific enumeration number

svc_find_xprt (9)    - find an RPC transport instance

usb_find_alt_setting (9) - Given a configuration, find the alternate setting for the given 
interface.

usb_find_interface (9) - find usb_interface pointer for driver and device

usb_hub_find_child (9) - Get the pointer of child device attached to the port which is specified by port1.

usb_match_id (9)     - find first usb_device_id matching device or interface

xprt_lookup_rqst (9) - find an RPC request corresponding to an XID

adjtimexconfig (8)   - find kernel clock variables and save for reboots

asn1_find_node (3)   - API function

asn1_find_structure_from_oid (3) - API function

AuLookupEventHandler (3nas) - find the next handler for an event.

BIO_find_type (3ssl) - BIO chain traversal

bogotune (1)         - find optimum parameter settings for bogofilter

bogotune-bdb (1)     - find optimum parameter settings for bogofilter

btrfs-find-root (8)  - filter to find btrfs root

build-rdeps (1)      - find packages that depend on a specific package to build (reverse build 
depends)

cluster (1)          - find clusters in a graph and augment the graph with this information.

DBI::Mock (3pm)      - mock a DBI if we can't find the real one

deborphan (1)        - Orphaned package finder

Devel::InnerPackage (3pm) - find all the inner packages of a package

Email::Find (3pm)    - Find RFC 822 email addresses in plain text

Email::Find::addrspec (3pm) - exports $Addr_spec_re to Email::Find

exinext (8)          - Finding individual retry times

exiwhat (8)          - Finding out what Exim processes are doing

FcConfigFilename (3) - Find a config file

ffind (1)            - Finds the name of the file or directory using a given inode

ffs (3)              - find first bit set in a word

ffsl (3)             - find first bit set in a word

ffsll (3)            - find first bit set in a word

File::Find (3perl)   - Traverse a directory tree.

File::HomeDir (3pm)  - Find your home and other directories on any platform

File::HomeDir::Darwin (3pm) - Find your home and other directories on Darwin (OS X)

File::HomeDir::Darwin::Carbon (3pm) - Find your home and other directories on Darwin (OS X)

File::HomeDir::Darwin::Cocoa (3pm) - Find your home and other directories on Darwin (OS X)

File::HomeDir::FreeDesktop (3pm) - Find your home and other directories on FreeDesktop.org Unix

File::HomeDir::MacOS9 (3pm) - Find your home and other directories on legacy Macs

File::HomeDir::Unix (3pm) - Find your home and other directories on legacy Unix

File::HomeDir::Windows (3pm) - Find your home and other directories on Windows

File::IconTheme (3pm) - find icon directories

File::UserDirs (3pm) - find extra media and documents directories

find (1)             - search for files in a directory hierarchy

findaffix (1)        - Interactive spelling checking

FindBin (3perl)      - Locate directory of original perl script

findfs (8)           - find a filesystem by label or UUID

findhyph (1)         - (unknown subject)

findmnt (8)          - find a filesystem

git-bisect (1)       - Use binary search to find the commit that introduced a bug

git-cherry (1)       - Find commits yet to be applied to upstream

git-merge-base (1)   - Find as good common ancestors as possible for a merge

git-name-rev (1)     - Find symbolic names for given revs

git-pack-redundant (1) - Find redundant pack files

glob (3)             - find pathnames matching a pattern, free memory from glob()

globfree (3)         - find pathnames matching a pattern, free memory from glob()

gst-typefind-1.0 (1) - print Media type of file

gtkorphan (8)        - A graphical tool to find and remove orphaned libraries

gvmap (1)            - find clusters and create a geographical map highlighting clusters.

hfind (1)            - Lookup a hash value in a hash database

ifind (1)            - Find the meta-data structure that has allocated a given disk unit or file 
name.

IPC::Cmd (3perl)     - finding and running system commands made easy

jdb (1)              - Finds and fixes bugs in Java platform programs.

john (8)             - a tool to find weak passwords of your users

kfind (1)            - file find utility for KDE

lfind (3)            - linear search of an array

locate (1)           - find files by name

Mail::SpamAssassin::ArchiveIterator (3pm) - find and process messages one at a time

mdatabase_find (3m17n) - Look for a data in the database.

memdiskfind (1)      - Simple utility to find a resident memdisk instance.

mflt_find (3m17n)    - Find an FLT suitable for the specified character and font.

mfont_find (3m17n)   - Find a font.

mlocate (1)          - find files by name

Module::Find (3pm)   - Find and use installed modules in a (sub)category

Mojolicious::Routes (3pm) - Always find your destination with routes

Mojolicious::Routes::Match (3pm) - Find routes

mono-find-provides (1) - No manpage for this program.

mono-find-requires (1) - No manpage for this program.

mplist_find_by_key (3m17n) - Find a property of a specific key in a property list.

mplist_find_by_value (3m17n) - Find a property of a specific value in a property list.

mtext_line_break (3m17n) - Find a linebreak postion of an M-text.

mtext_prop_range (3m17n) - Find the range where the value of a text property is the same.

OCSP_resp_find (3ssl) - OCSP response utility functions

OCSP_resp_find_status (3ssl) - OCSP response utility functions

OPENSSL_sk_find (3ssl) - stack container

OPENSSL_sk_find_ex (3ssl) - stack container

Path::Iterator::Rule (3pm) - Iterative, recursive file finder

perlmodlib (1)       - constructing new Perl modules and finding existing ones

pidof (8)            - find the process ID of a running program.

Pod::Find (3perl)    - find POD documents in directory trees

Pod::Simple::Search (3perl) - find POD documents in directory trees

ppsfind (8)          - LinuxPPS support tools and headers

tree (3)             - implementations of splay and red-black trees

sane-find-scanner (1) - find SCSI and USB scanners and their device files

sgmldiff (1)         - Find differences in the markup of two SGML files

sigfind (1)          - Find a binary signature in a file

sk_TYPE_find (3ssl)  - stack container

sk_TYPE_find_ex (3ssl) - stack container

stringlist (3)       - stringlist manipulation functions

SPI_cursor_find (3)  - find an existing cursor by name

systemd-delta (1)    - Find overridden configuration files

texdoc (1)           - find & view documentation in TeX Live

tfind (3)            - manage a binary tree

Tk::X11Font (3pm)    - a class for finding X Fonts

ttyslot (3)          - find the slot of the current user's terminal in some file

tv_find_grabbers (1p) - Find all XMLTV grabbers that are installed on the system.

unhide (8)           - forensic tool to find hidden processes

unhide-linux (8)     - forensic tool to find hidden processes

unhide-posix (8)     - forensic tool to find hidden processes

unhide-tcp (8)       - forensic tool to find hidden TCP/UDP ports

unhide_rb (8)        - forensic tool to find hidden processes

xdg-user-dir (1)     - Find an XDG user dir

XFindContext (3)     - associative look-up routines

XkbFindOverlayForKey (3) - Find the alternate name by using the primary name for a key that is part 
of an overlay

XkbGetControls (3)   - Finds the current state of Xkb server controls

XkbKeycodeToKeysym (3) - Finds the keysym bound to a particular key at a specified group and shift 
level

XkbKeysymToModifiers (3) - Finds the set of modifiers bound to a particular keysym on the core 
keyboard

XkbLookupKeyBinding (3) - Find the string bound to a key by XRebindKeySym

XkbLookupKeySym (3)  - Find the symbol associated with a key for a particular state

XkbTranslateKeySym (3) - Find the string and symbol associated with a keysym for a given keyboard 
state

XtFindFile (3)       - search for a file using substitutions in the path list
Those are man files, so you view them with the "man" command.
 
  


Reply


Thread Tools Search this Thread
Search this Thread:

Advanced Search

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is Off
HTML code is Off



Similar Threads
Thread Thread Starter Forum Replies Last Post
libjpeg-turbo installs documentation into /usr/doc aaazen Slackware 1 08-12-2015 07:49 AM
[SOLVED] Linux MintDEBIAN Edition Hangs at installation"copying usr/share/doc/./RELNOTES-6.3.1 silvyus_06 Linux - Newbie 5 02-10-2011 05:14 PM
[SOLVED] /usr/share/doc/cups/online-docs/index.html kaz2100 Debian 1 05-12-2010 05:09 PM
App to keep track of /usr/share/doc stuff? drudge Linux - Software 3 02-20-2009 08:17 AM
Konqueror + file:/usr/share/doc/HTML/index.html jon_k Linux - Software 2 11-25-2003 05:06 AM

LinuxQuestions.org > Forums > Linux Forums > Linux - Newbie

All times are GMT -5. The time now is 09:49 PM.

Main Menu
Advertisement
My LQ
Write for LQ
LinuxQuestions.org is looking for people interested in writing Editorials, Articles, Reviews, and more. If you'd like to contribute content, let us know.
Main Menu
Syndicate
RSS1  Latest Threads
RSS1  LQ News
Twitter: @linuxquestions
Open Source Consulting | Domain Registration