Tag Info

New answers tagged

4

Square brackets are a common convention in documentation to indicate that what is inside the bracket is optional. They are part of the metasyntax used by the documentation. The ... notation is also metasyntax; it indicates that the preceding element may be repeated. Other common metasyntax include parentheses for grouping and | to mean “or”. Here, it ...


7

Read the authoritative source: the GNU bash manual https://www.gnu.org/software/bash/manual/bashref.html#Conditional-Constructs The square brackets indicate optional stuff. The only mandatory parts are: case word in esac -- this is valid bash that happens to do nothing.


1

According to this page, it's easy: nano nuseradd Then paste and modify an example like this one. This page (or man 7 mdoc) explains the formatting options: .\" Manpage for nuseradd. .\" Contact vivek@nixcraft.net.in to correct errors or typos. .TH man 8 "06 May 2010" "1.0" "nuseradd man page" .SH NAME nuseradd \- create a new LDAP user .SH SYNOPSIS ...


5

To create Info documentation, you first need a texi file. .texi - Texinfo is a typesetting syntax used for generating documentation in both on-line and printed form (creating filetypes as dvi, html, pdf, etc., and its own hypertext format, info) with a single source file. It is implemented by a computer program released as free software of the same name, ...


0

I just use grep. If i were to wonder what the -s option of the read command did, i'd try these commands in order until i got an answer: info read |grep \\-s man read |grep \\-s help read |grep \\-s In this case only the info command provided a clear answer. This excellent answer gives the details on the different help systems.


4

There are a handful of exit codes with reserved special meanings: Exit Code Number Meaning 1 Catchall for general errors 2 Misuse of shell builtins (according to Bash documentation) 126 Command invoked cannot execute 127 "command not found" 128+n Fatal error signal "n" 130 Script terminated by Ctrl-C 255* Exit status out of range ...


5

tl;dr Exit codes are application specific. There are some loose conventions. false and anything successful prefixed with ! (like ! true) in POSIX shells return exit code 1, but a developer can use any exit code between 0 and 255 for whatever they want. Ultimately you have to look at its documentation (in the best case) or the code (in the worst case) to ...


2

help is a built-in command in the bash shell (and that shell only) that documents some of the builtin commands and keywords of that shell. That's an internal documentation system of that shell. Other shells have their own documentation system (ksh93 has --help and --man options for its builtins, zsh has a run-help helper that extracts information from ...



Top 50 recent answers are included