Author Topic: [LINUX] Finding out where package documentation is located  (Read 190 times)

0 Members and 1 Guest are viewing this topic.

Offline Stephan

  • aka HcH, TechKnow Owner, EHVSN Admin
  • Administrator
  • Uber Member
  • *****
  • Posts: 9689
  • Karma: +2280/-106
[LINUX] Finding out where package documentation is located
« on: March 03, 2018, 12:14:58 PM »
Finding out where the documentation is of a installed package is.

Using Linux will require you to read documentation about the packages you're going to use. Usually there are 2 easy ways to get more information about the packages that are installed:

1. Shell: man 'packagename'
2. Default storage location: /usr/share/doc/'packagename'

I tried a experimental package and it mentioned I should read the documentation, but not where the documentation was located, it wasn't in the default /usr/share/doc/ directory. Usually you can also type "man 'packagename'" to get detailed help but in this case I believe something went wrong with the installation because that also didn't work.

I followed these steps and found the documentation:

1. Search for the name of the package:
cd / & find . -name 'packagename'*

2. Usually we can see results in /usr/share/lintian/overrides:
cat /usr/share/lintian/overrides/'packagename'

[email protected]:/usr/share/lintian/overrides# cat 'packagename'
# INSTALL contains some important caveats.
'packagename': package-contains-upstream-install-documentation usr/share/doc/'packagename'/INSTALL.gz (INSTALL.gz is an example, it could be a different filename)

3. Decompress the help file:
gzip -d usr/share/doc/labrea/INSTALL.gz

4. Read the help file:
cat or leafpad usr/share/doc/labrea/INSTALL
« Last Edit: March 03, 2018, 02:53:37 PM by Stephan »