Différences
Ci-dessous, les différences entre deux révisions de la page.
| Prochaine révision | Révision précédente | ||
| elearning:workbooks:redhat:rh124en:l102 [2024/11/04 13:34] – created admin | elearning:workbooks:redhat:rh124en:l102 [2024/11/25 13:04] (Version actuelle) – admin | ||
|---|---|---|---|
| Ligne 7: | Ligne 7: | ||
| ======RH12403 - Help and Documentation====== | ======RH12403 - Help and Documentation====== | ||
| - | =====Module content===== | + | =====Contents===== |
| * **RH12403 - Help and Documentation** | * **RH12403 - Help and Documentation** | ||
| - | * Module contents | + | * Contents |
| - | * LAB #1 - Order Help | + | * LAB #1 - Help with Commands |
| - | * 1.1 - External | + | * 1.1 - Help on External Commands |
| - | * 1.2 - Help on Internal Shell Commands | + | * 1.2 - Help on Built-In |
| * LAB #2 - The man command | * LAB #2 - The man command | ||
| * 2.1 - The mandb and whatis commands | * 2.1 - The mandb and whatis commands | ||
| Ligne 19: | Ligne 19: | ||
| * LAB #3 - The info command | * LAB #3 - The info command | ||
| - | =====LAB #1 - Command help===== | + | =====LAB #1 - Help with Commands===== |
| - | ====.1 - Help with External | + | ====1.1 - Help on External Commands==== |
| External shell commands are executable binaries or scripts, usually located in /bin, /sbin, /usr/bin or /usr/sbin : | External shell commands are executable binaries or scripts, usually located in /bin, /sbin, /usr/bin or /usr/sbin : | ||
| Ligne 32: | Ligne 32: | ||
| </ | </ | ||
| - | The help of an external shell command can be viewed in most cases by passing the **- -help** parameter as an argument to the command in question: | + | The help of an external shell command can be viewed in most cases by passing the **--help** parameter as an argument to the command in question: |
| < | < | ||
| Ligne 70: | Ligne 70: | ||
| </ | </ | ||
| - | ====.2 - Help on Internal Shell Commands==== | + | ====1.2 - Help on Built-In |
| - | Internal | + | Built-In or internal |
| < | < | ||
| Ligne 79: | Ligne 79: | ||
| </ | </ | ||
| - | The shell has the **help** command. Used alone, this command provides the list of internal | + | The shell has the **help** command. Used alone, this command provides the list of built-in |
| < | < | ||
| Ligne 163: | Ligne 163: | ||
| </ | </ | ||
| - | =====LAB #2 - The man===== | + | =====LAB #2 - The man command===== |
| The man command provides access to the manual for the command passed as an argument. For example **man passwd** : | The man command provides access to the manual for the command passed as an argument. For example **man passwd** : | ||
| Ligne 237: | Ligne 237: | ||
| | DESCRIPTION | Instructions for use and main arguments | | | DESCRIPTION | Instructions for use and main arguments | | ||
| | OPTIONS | Detailed descriptions of each parameter | | | OPTIONS | Detailed descriptions of each parameter | | ||
| - | | EXAMPLES / EXAMPLES | Examples of command use | + | | EXAMPLES | Examples of command use | |
| - | | ENVIRONMENT / ENVIRONMENT VARIABLES | Shell environment operation | + | | ENVIRONMENT VARIABLES | Shell environment operation |
| - | | CONFORMITY / STANDARDS / CONFORMING TO | Possible standards to which the command conforms | | + | | STANDARDS / CONFORMING TO | Possible standards to which the command conforms | |
| - | | BUGS/TO DO | Known bugs, if any | DIAGNOSTICS | + | | BUGS/TO DO | Known bugs, if any | |
| - | | DIAGNOSTICS/ | + | | EXIT STATUS/ |
| - | | SEE ALSO / SEE ALSO | Commands related to those in the current manual | | + | | SEE ALSO | Commands related to those in the current manual | |
| The manual page is navigated by using certain keys: | The manual page is navigated by using certain keys: | ||
| ^ Key ^ Function ^ | ^ Key ^ Function ^ | ||
| - | | <key>space</ | + | | <key>Space Bar</ |
| - | | <key>enter</ | + | | <key>Enter</ |
| - | | < | + | | < |
| - | | < | + | | < |
| - | | <key>%PageUp%%</ | + | | < |
| - | | <key>%PageBas%%</ | + | | <key>PageDown</ |
| - | | <key>Begin</ | + | | <key>Home</ |
| - | | < | + | | < |
| - | | Search for the string | + | | < |
| - | | <key>Q</ | + | | <key>q</ |
| A complete manual is made up of several sections: | A complete manual is made up of several sections: | ||
| ^ Section ^ Contents ^ | ^ Section ^ Contents ^ | ||
| - | | 1 | Executable | + | | 1 | Executable |
| - | | 2 | System calls | | + | | 2 | System calls (functions provided by the kernel) |
| - | | 3 | Library calls | | + | | 3 | Library calls (functions within program libraries) |
| - | | 4 | Special files | | + | | 4 | Special files (usually found in /dev) | |
| - | | 5 | File format | + | | 5 | File formats and conventions eg /etc/passwd | |
| - | | 6 | Games, screensavers, | + | | 6 | Games and Gadgets |
| - | | 7 | Miscellaneous and non-standard commands | + | | 7 | Miscellaneous |
| - | | 8 | Linux system | + | | 8 | System |
| - | | 9 | Kernel | + | | 9 | Kernel |
| The various available sections can be viewed using the **whereis** command: | The various available sections can be viewed using the **whereis** command: | ||
| Ligne 343: | Ligne 343: | ||
| </ | </ | ||
| - | ====2.1 - The mandb and whatis==== | + | ====2.1 - The mandb and whatis |
| Each manual page contains a brief description. These descriptions and the name of the manual are stored in the **whatis** database. | Each manual page contains a brief description. These descriptions and the name of the manual are stored in the **whatis** database. | ||
| - | This database can be maintained manually by root by invoking the **/ | + | This database can be maintained manually by root by invoking the **/ |
| - | + | ||
| - | Using **mandb** is very simple: | + | |
| < | < | ||
| Ligne 413: | Ligne 411: | ||
| </ | </ | ||
| - | The **whatis** command can now be used to identify the manual sections available for a given order: | + | The **whatis** command can now be used to identify the manual sections available for a given command: |
| < | < | ||
| Ligne 422: | Ligne 420: | ||
| </ | </ | ||
| - | ====2.2 - The apropos==== | + | ====2.2 - The apropos |
| The **apropos** command searches the **whatis** database for the character string passed as an argument to the command. Without options, the output is identical to the **man -k** command: | The **apropos** command searches the **whatis** database for the character string passed as an argument to the command. Without options, the output is identical to the **man -k** command: | ||
| Ligne 451: | Ligne 449: | ||
| </ | </ | ||
| - | =====LAB #3 - The info===== | + | =====LAB #3 - The info Command |
| In addition to the manual system, information about executables can be found in the **info** system. Detailed information, | In addition to the manual system, information about executables can be found in the **info** system. Detailed information, | ||
| Ligne 459: | Ligne 457: | ||
| To facilitate navigation, each page contains a header that includes information on the current node, the parent node, the previous node and the next node. To navigate between nodes, use the following keys: | To facilitate navigation, each page contains a header that includes information on the current node, the parent node, the previous node and the next node. To navigate between nodes, use the following keys: | ||
| - | ^ Touch ^ Function ^ | + | ^ Key ^ Function ^ |
| | n | Next node. | | | n | Next node. | | ||
| | p | Previous node. | | | p | Previous node. | | ||
| | u | Parent node. | | | u | Parent node. | | ||
| - | | <key>Space</ | + | | <key>space</ |
| - | | <key>Suppr</ | + | | <key>Del</ |
| - | | Return to the beginning of the current node. | + | | b | Return to the beginning of the current node. | |
| - | | < | + | | < |
| - | | m < | + | | m < |
| - | | < | + | | < |
| - | | Exit the **info** system. | | + | | q | Quit the info system. | |
| To access the first node, use the following command: | To access the first node, use the following command: | ||
