Questions tagged [documentation]

Manuals or other information for system users detailing software features and functionality.

Text or HTML documents that accompany software to explain the features and functionality of the application for the end user. Documentation can take the form of:

  • man (manual) pages
  • info pages for GNU projects
  • README files
  • HMTL pages on the application's website or packaged to be viewed on the user's machine
239 questions
17
votes
8 answers

Beginning to learn Unix and Linux

I need to learn unix and linux, and be a professional. Where should I start?
12
votes
3 answers

Where is the syntax for /etc/environment documented?

I want to know the exact syntax for /etc/environment. I know it's not an ordinary shell script, but how exactly are single and double quotes processed? Can environment variables defined earlier in the file be used to define later variables? How does…
nerdfever.com
  • 303
  • 1
  • 3
  • 7
6
votes
2 answers

Is there a readme reader like man?

man is the quick interface to online reference manuals. These are usually stored in /usr/share/man/manN/blah.gz, or similar. Most debian packages also come with a README.debian, which is stored in /usr/share/doc/blah/README.debian. Is there an…
naught101
  • 739
3
votes
6 answers

What GNU/Linux magazines, e-zines are available?

What GNU/Linux specific magazines, e-zines (free and paid) are there ?
Lincity
  • 206
3
votes
1 answer

Why there is no Linux Handbook?

Look e.g. onto the BSD's family: FreeBSD Handbook: http://www.freebsd.org/doc/en/books/developers-handbook/debugging.html OpenBSD FAQ, nearby FreeBSD's Handbook: http://www.openbsd.org/faq/index.html I'm really discouraged what can be called…
2
votes
1 answer

lshw tool and returned options and their meanings

The tool lshw reports information about all connected hardware. Some reported options and features are simple enough to understand, while others are not. The documentation page found here and the project page do not define all of these features and…
CybeX
  • 296
1
vote
1 answer

Standard utilities notation for SYNOPSIS sections

I want to construct a program utility synopsis for optional comma separated keywords. utility [KEYWORD[,KEYWORD]...] I worder where I should put the repeating pattern .... I want to allow the following usage utility utility keyword utility…
Vera
  • 1,223
1
vote
0 answers

How do I preview a unix document file?

I want to preview these unix docs : https://github.com/axboe/liburing/tree/master/man , what should I do?
Rick
  • 1,157
0
votes
2 answers

What is the intention of undocumented option "netserver -D"?

The netserver binary is often used for network performance profiling in conjunction with iperf3. In many contexts including other Stack Exchange questions, the method for launching netserver is shown with a mystery -D option. The -D option is not…
Rich
  • 823
0
votes
1 answer

The difference between Documentation Methods

I am confused about a three Documentation techniques used, I have The following questions concerning man , pinfo , /usr/share/doc Does the man command Display the same content like pinfo and just the difference in the way they display information…