Stack Exchange Network

Stack Exchange network consists of 175 Q&A communities including Stack Overflow, the largest, most trusted online community for developers to learn, share their knowledge, and build their careers.

Visit Stack Exchange

Questions tagged [documentation]

For questions regarding written documentation such as manuals, help files, policies, instructions, or guides.

88
votes
3answers
28k views

What is the difference between “man” and “info” documentation?

Regarding man-pages and info help documentation: Why do two such similar sources of documentation exist? Sometimes a man-page is available and the info is not; or vice-versa. I haven't yet latched ...
53
votes
5answers
31k views

Remove documentation to save hard drive space

I like to create a rather small Ubuntu installation in a Virtual Box machine. It should basically just provide TeX Live and related tools. I figured now that I have almost 1GB of data under /usr/share/...
41
votes
6answers
13k views

How are typical users expected to read the documentation in /usr/share/doc?

I recently learned that there is a huge pile of documentation in /usr/share/doc. It seems like much of it is gzipped so that it is not directly accessible without administrative privileges: $ gunzip ...
38
votes
3answers
60k views

Do files at /etc/apt/sources.list.d need to have an extension '.list'?

In /etc/apt/sources.list.d I have several files for custom repositories. All the names of those files end with .list. Is it obligatory that files in that folder should end with that extension? If yes,...
31
votes
9answers
5k views

How can I get help on terminal commands?

I often see things like read man xyz For more information read xyz's man page. see info xyz so I wonder: How can I get help on terminal commands generally? What exactly are these man and ...
26
votes
2answers
10k views

What advantages does markdown have over asciidoc?

I've been using Asciidoc ever since I discovered it and use it a lot to be my defacto README text file. It's readable in text and it can output all kinds of other formats, like man pages, pdf, html, ...
20
votes
5answers
2k views

zsh man page documentation missing in packages?

I have a newly installed xubuntu 13.10 x64. I decided to install zsh via synaptic and make it my default shell. The installed zsh's version is: zsh 5.0.2 (x86_64-pc-linux-gnu). The installed zsh ...
19
votes
1answer
21k views

What does the kernel taint value mean?

Running cat /proc/sys/kernel/tainted prints the current kernel taint value (in base 10). My understanding is that this value is a bitfield, where each bit indicates the absence or presence of a ...
19
votes
1answer
4k views

In 'apt-cache depends' output, what is the meaning of Suggests, Recommends, |, <>?

I've checked the man/info page, but there is no reference to some aspects of the output fomat of apt-cache depends The man/info page tried to be helpful (in an obtuse manner); quote: "For the ...
19
votes
4answers
4k views

Are there any GUI man page editors are available?

I find the man page format extremely painful to write. Is there a GUI (WYSIWYG or WYSIWYM) editor available to make this task easier? I'm hoping for an application that is to man pages as Kompozer is ...
18
votes
2answers
11k views

“No manual entry for pthread” - could not find man page by name

I am new to Ubuntu, wanted to code for reader-writer block in Operating System, but when I fired the command man pthread it gave me an error no manual entry for pthread. What can be done to resolve ...
18
votes
1answer
4k views

Where is the kernel documentation?

In CentOS I can do yum install kernel-doc and then read /usr/share/doc/kernel-doc/Documentation/filesystems/proc.txt. How would I do the equivalent in Ubuntu? Professor Google told me it was in the ...
18
votes
1answer
2k views

Is there a detailed API documentation on the python binding for appindicator?

I'm getting serous with a project of my own and need a good documentation on the appindicator module for python. What I've found so far: API documentation on dev.ubuntu.com Community wiki entry API ...
15
votes
5answers
1k views

User guide for users migrating from Windows?

I am new user for ubuntu. I want to use ubuntu for my python development. I used windows7 for .net development. Is there any guide which help me in migration from Windows to Ubuntu?
15
votes
2answers
9k views

I have installed python-doc. How can I access it?

Sorry if this is a such an obvious question, but where does Ubuntu put documentation packages for python, node.js, redis, mysql, mongodb, and other applications? And why I cannot access it by typing ...
15
votes
3answers
923 views

Developer documentation for the Messaging Menu?

The only documentation I have been able to find on integrating an application with the Messaging Menu is old and out of date: http://gnomejournal.org/article/67/an-introduction-to-the-message-...
15
votes
3answers
334 views

Is there a common use case documentation available for Unity?

Unity will introduce a new desktop paradigm for most of us. Therefore alot of people may wonder how to perform their common use cases, e.g.: how do I open an application? how do I find an application?...
14
votes
4answers
9k views

How do I get help for “echo” or other bash commands?

man echo works. but out of curiosity, does echo have something similar to a --help flag/parameter?
14
votes
1answer
2k views

What is the use of *-doc packages?

I was installing some programs, and every program has a XXX-doc package. I suppose it's for documentation, maybe even for man pages? Because I get a documentation online, thus in that case may I ...
14
votes
2answers
7k views

Architecture diagram explaining the Ubuntu Cloud Infrastructure with MAAS / Openstack architecture?

I'm interested in Ubuntu Cloud Infrastructure with MAAS (based on Openstack from what I understand) but cannot find any architecture diagram which gives an overview of how MAAS works. The case is ...
14
votes
2answers
3k views

How does the Trash Can work, and where can I find official documentation, reference, or specification for it?

When trying to manage trash can from mounted NTFS volumes, I ended up reading FreeDesktop.org's reference on it. Poking around and doing some tests, I realized Ubuntu/Gnome does not follow the specs ...
13
votes
2answers
1k views

What do the symbols in service --status-all mean? [duplicate]

I really miss the graphical "Services" tool from older versions of Ubuntu, but I understand why it had to go. I always have terminals open anyway, so I use (because I have to now, I guess) service --...
13
votes
3answers
3k views

How do I search for `!` (exclamation mark) in a manual page?

I want to get the explanation for ! option (which means exclude) in find command in the man find. And then I press / and shift + 1 , a Non-match popped out, instead of ! So my question is how to ...
13
votes
2answers
384 views

Linking to man page sections?

Online man pages in HTML with section anchors? It would be good to have an online version of the Ubuntu man pages with direct links into subsections. That would allow to point someone to the relevant ...
12
votes
6answers
26k views

How do I view the man pages?

I'm new to Linux. I got the "Unix And Linux System Administration Handbook" It speaks of several verisons of linux and unix, and the commands for viewing linux man pages and not specific to ubuntu. ...
12
votes
2answers
1k views

How can I read man pages in my native language?

How can I read man pages in my mother tongue? I'd also like to contribute some translations. Where should I go? Is there a community supported by Canonical?
11
votes
3answers
24k views

Ubuntu 14.04 QtCreator Qt5 examples missing

After upgrading to Ubuntu 14.04 I removed the official qtcreator in order to install the modified version from the software center because I'd like to try the SDK. Fortunately, the docs are now ...
11
votes
7answers
3k views

Are there any good books for new Ubuntu users? [closed]

I recently installed Ubuntu in my uncle's laptop. He seems to like it and he is asking me for some good Ubuntu books for beginners. I was thinking about The Official Ubuntu Book. Any other suggestions ...
11
votes
1answer
891 views

Is there an English Ubuntu Wiki?

When answering a question here on Ask Ubuntu I sometimes would like to link to a wiki page explaining some topic in more detail, say, the ALSA sound system. For German speaking users there's the ...
11
votes
3answers
7k views

What are the files in /dev/input/ and what they do?

I'm fairly new to ubuntu and I've started to search around everywhere and check everything! Recently I saw these files at /dev/input/eventX, js0, mice, mouseX. By printing the output using "cat" I ...
10
votes
1answer
247 views

How do I contribute documentation to Juju?

I've found some bugs in the Juju Documentation that I'd like to fix, but the docs are in some format I've not seen before, how can I contribute?
9
votes
3answers
1k views

How to read package description or man page without installing?

How can I get information about a package before installing it, from the terminal? I mean something like man pages, but accessible even before the package is installed.
9
votes
5answers
3k views

How to have colored manual pages in gnome-terminal

When I switched to tty I noticed manpages look different by using some color scheme. How to make it to gnome-terminal? Update: Here is a solution, I found at Unix stackExchange site.
9
votes
3answers
3k views

Download C++ reference

I'm learning C++ and are currently for some weeks without consistently working Internet connection. I search a (ASCII) terminal searchable & readable C++ documentation. Today I e. g. searched for ...
9
votes
2answers
56k views

Wireless configuration using /etc/network/interfaces documentation

I followed the tutorial here and was able to properly configure my network: http://ubuntuforums.org/showthread.php?t=202834&page=181 I know of the documentation in /usr/share/doc/wireless-tools/...
8
votes
3answers
22k views

Hotkey for “Kde button” menu? And default shortcut-keys cheatsheets?

What's the hotkey to open that thing in KDE that's basically like the Windows' "Start" menu? I've found it surprisingly hard to find some basic hotkey cheatsheets for my shiny new install of Kubuntu.....
8
votes
4answers
11k views

How can I get raw text output of a manual in my terminal

How can I get raw text output of a manual in my terminal? I want to have the manual without a "less" type screen displayed.
8
votes
3answers
324 views

How to get paragraph for certain option of command right away?

For example instead of whole manual of apt-get I want jump to -f option from terminal prompt right away, without using search through manpage.
8
votes
1answer
5k views

How to install packages without documentation?

Stage I am using Ubuntu 12.04. I want to install some TexLive packages, but they requires their own documentation packages. For example: texlive-latex-extra pulls texlive-latex-extra-doc. texlive-...
8
votes
2answers
223 views

How do I distinguish between a command, utility, or builtin for getting documentation?

I'm running Bash scripting, but sometimes I get confused which of these commands I use belong to who. Sometimes man xxx works, sometimes doesn't, so I use --help or info, mostly one of these works to ...
7
votes
3answers
2k views

How to see all available `man` manuals?

How do I tell man to show me a list of all the 'manuals' installed on my Ubuntu 10.10 system? Also, is there a specific directory where the manual pages are installed?
7
votes
2answers
7k views

What are all the apt command-line commands and options?

I know they think that they are being helpful, but in fact they are being quite the opposite here in the apt --help and manpage: Much like apt itself, its manpage is intended as an end user ...
7
votes
2answers
17k views

How can I know which version of the C++ “standard library” is installed?

I would like to install the C++ standard library documentation (following the answers in Download C++ reference) but I do not know which version of library is installed in my Ubuntu.
7
votes
1answer
636 views

Emacs info manual missing in Ubuntu 17.10

On Ubuntu 17.10, installing Emacs via $sudo apt install emacs and then trying to view the Emacs manual using C-h r fails with error "Info file emacs does not exist" The same set of instructions on ...
7
votes
2answers
136 views

Command has no manual?

I recently installed youtube-dl. I first used apt-get to install it. However, the version was outdated and there were problems. I was able to look through the documentation using man youtube-dl. In ...
7
votes
1answer
938 views

I can't get dwww to work - Keeps getting 404 Not Found

When I try to click on a link on the web page produced by dwww - I get the following error: Not Found The requested URL /cgi-bin/dwww/usr/share/doc/ was not found on this server. Apache/2.4.10 (...
7
votes
1answer
162 views

Differences between Official and Community documentation?

Ubuntu provides Official and Community documentation. Why create the two streams? Is the official documentation more trustworthy? Is the criteria to add to it more strict?
7
votes
2answers
274 views

How to change the language in which official Ubuntu documentation (online) is displayed?

The official Ubuntu documentation is available at https://help.ubuntu.com/. Curiously, it automatically displays the content in the locale that the user's browser provides, without any option to ...
6
votes
4answers
2k views

Where is the end user documentation for Unity?

Is there any end user documentation for the Unity launcher? Failing that, is there at least something as tips&tricks or reference materials (for example, a list of available keyboard shortcuts, ...
6
votes
3answers
7k views

What is a easy way to view texi files?

I am reading some files for a library I plan on using and the files are of extension '.texi' and although I can open the files in gedit, all the syntax and markups make it difficult to read. Also, I ...