Help (command)

The end of the HELP command output from RT-11SJ displayed on a VT100.

The BusyBox HELP command

In computing, help is a command in various command line shells such as COMMAND.COM, cmd.exe, Bash, qshell, 4DOS/4NT, Windows PowerShell, Singularity shell, Python, MATLAB^[1] and GNU Octave.^[2] It provides online information about available commands and the shell environment.^[3]

Implementations

Information about the help command for DCL on RSX-11

The ReactOS help command

The command is available in operating systems such as Multics,^[4] Heath Company HDOS,^[5] CP/M Plus, DOS, IBM OS/2,^[6] eComStation, ArcaOS, IBM i,^[7] Microsoft Windows, ReactOS,^[8] THEOS/OASIS,^[9] Zilog Z80-RIO,^[10] Microware OS-9,^[11] Stratus OpenVOS,^[12] HP MPE/iX,^[13] Motorola VERSAdos,^[14] KolibriOS^[15] and also in the DEC RT-11,^[16] RSX-11,^[17] TOPS-10^[18] and TOPS-20^[19] operating systems. Furthermore it is available in the open source MS-DOS emulator DOSBox and in the EFI shell.^[20]

On Unix, the command is part of the Source Code Control System and prints help information for the SCCS commands.

Multics

The Multics help command prints descriptions of system commands/active functions and subroutines. It also prints various information about the system status, system changes, and other general information. This information is selected from segments maintained online, which are in a special format, called information segments. More than 800 information segments are available.^[21]

DEC OS/8

The DEC OS/8 CCL help command prints information on specified OS/8 programs.^[22]

DOS

MS-DOS

The help command is available in MS-DOS 5.x and later versions of the software.^[23] The help command with a 'command' parameter would give help on a specific command. If no arguments are provided, the command lists the contents of DOSHELP.HLP.

In MS-DOS 6.x this command exists as FASTHELP.

The MS-DOS 6.xx help command uses QBasic to view a quickhelp HELP.HLP file, which contains more extensive information on the commands, with some hyperlinking etc. The MS-DOS 6.22 help system is included on Windows 9x CD-ROM versions as well.

PC DOS

In PC DOS 5 and 6 help is the same form as MS-DOS 5 help command.

PC DOS 7.xx help uses view.exe to open OS/2 style INF files (cmdref.inf, dosrexx.inf and doserror.inf), opening these to the appropriate pages.

PC-MOS

The Software Link's PC-MOS includes an implementation of help.^[24] Like the rest of the operating system, it is licensed under the GPL v3.^[25]

DR-DOS

In DR-DOS, help is a batch file that launches DR-DOS' internal help program, dosbook.

ROM-DOS

Datalight ROM-DOS includes an implementation of the help command.^[26] ROM-DOS was introduced in 1989 as an MS-DOS compatible operating system designed for embedded systems.

FreeDOS

The FreeDOS version was developed by Joe Cosentino.^[27]

4DOS/4NT

The 4DOS/4NT help command uses a text user interface to display the online help.

cmd.exe

Pocket CMD v 3.0 (cmd.exe) on Windows CE 3.0 showing the help command output

Used without parameters, help lists and briefly describes every system command. Windows NT-based versions use MS-DOS 5 style help. Versions before Windows Vista also have a Windows help file (NTCMDS.HLP or NTCMDS.INF) in a similar style to MS-DOS 6.

PowerShell

In PowerShell, help is a short form (implemented as a PowerShell function) for access to the Get-Help Cmdlet.

Windows PowerShell includes an extensive, console-based help system, reminiscent of man pages in Unix. The help topics include help for cmdlets, providers, and concepts in PowerShell.

GNU Bash

In Bash, the builtin command help'^[28] lists all Bash builtin commands if used without arguments. Otherwise, it prints a brief summary of a command. Its syntax is:

help [-dms] [pattern]

OpenVMS

HELP is a DCL utility that contains information on the use of commands and descriptions of some OpenVMS concepts such as time formats and lexical functions, as well as lists of commands for a particular purpose (HELP Hints).

Syntax

The command-syntax is:

help [command]

Arguments:

• command This command-line argument specifies the name of the command about which information is to be displayed.

Examples

DOSBox

Z:\>help
If you want a list of all supported commands type help /all .
A short list of the most often used commands:
<DIR     > Directory View.
<CD      > Display/changes the current directory.
<CLS     > Clear screen.
<COPY    > Copy files.
...

Python

Main article: Docstring

>>> help
Type help() for interactive help, or help(object) for help about object.
>>> help()

Welcome to Python 2.5!  This is the online help utility.

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at https://www.python.org/doc/tut/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".
...

GNU Octave

octave-3.0.0.exe:1> help

Help is available for the topics listed below.
Additional help for built-in functions and operators is
available in the on-line version of the manual.  Use the command
`doc <topic>' to search the manual index.
...

See also

• Online help
• List of DOS commands

References

1. "Help for functions in Command Window - MATLAB help". www.mathworks.com.
2. "Function Reference: help". octave.sourceforge.io.
3. "Microsoft TechNet Help article". 11 September 2009.
4. "Multics Glossary -H-". www.multicians.org.
5. Heath Company. "Software Reference Manual HDOS SYSTEM Chapter 2 General Operations" (PDF). Archived from the original (PDF) on 2017-08-07. Retrieved 2020-02-08.
6. "JaTomes Help - OS/2 Commands". Archived from the original on 2019-04-14. Retrieved 2019-07-27.
7. IBM. "IBM System i Version 7.2 Programming Qshell" (PDF). IBM. Retrieved 2020-09-05.
8. "reactos/reactos". GitHub. 3 January 2022.
9. THEOS/OASIS User′s Handbook
10. Z80-RIO OPERATING SYSTEM USER'S MANUAL
11. Paul S. Dayan (1992). The OS-9 Guru - 1 : The Facts. Galactic Industrial Limited. ISBN 0-9519228-0-7.
12. "Reference manual" (PDF). stratadoc.stratus.com. Retrieved 2020-09-14.
13. MPE/iX Command Reference Manual
14. M68000 Family VERSAdos System Facilities Reference Manual
15. "Shell - KolibriOS wiki". wiki.kolibrios.org.
16. "RT-11 HELP FILE". paleoferrosaurus.com. Archived from the original on 2018-07-17. Retrieved 2018-07-16.
17. John F. Pieper (1987). RSX A Guide for Users (PDF). Digital Equipment Corporation. ISBN 0-932376-90-8. Retrieved 2020-09-19.
18. TOPS-10 Operating System Commands Manual (PDF). Digital Equipment Corporation. August 1980. Archived from the original (PDF) on 2020-08-09. Retrieved 2019-02-17.
19. "TOPS-20 Command manual" (PDF). Archived from the original (PDF) on 2020-08-09. Retrieved 2018-07-18.
20. "EFI Shells and Scripting". Intel. Retrieved 2013-09-25.
21. Honeywell Bull, Inc. (Feb 1985). Multics Commands and Active Functions (AG92-06) (PDF). Archived from the original (PDF) on June 6, 2022. Retrieved Jan 10, 2021.
22. "Concise Command Language" (CCL)."OS/8 Handbook" (PDF). April 1974. Retrieved 28 November 2017.
23. Wolverton, Van (2003). Running MS-DOS Version 6.22 (20th Anniversary Edition), 6th Revised edition. Microsoft Press. ISBN 0-7356-1812-7.
24. "roelandjansen/pcmos386v501". GitHub. 2 January 2022.
25. Jansen, Roeland (8 February 2018). "pcmos386v501: PC-MOS/386 v5.01 final release including cdrom driver sources" – via GitHub.
26. "Datalight ROM-DOS User's Guide" (PDF). www.datalight.com.
27. "ibiblio.org FreeDOS Package -- Help (FreeDOS Base)". www.ibiblio.org.
28. "Bash Reference Manual". www.gnu.org. Retrieved 2016-05-09.

Further reading

• Wolverton, Van (1990). MS-DOS Commands: Microsoft Quick Reference, 4th Revised edition. Microsoft Press. ISBN 978-1556152894.
• Kathy Ivens; Brian Proffit (1993). OS/2 Inside & Out. Osborne McGraw-Hill. ISBN 978-0078818714.
• Frisch, Æleen (2001). Windows 2000 Commands Pocket Reference. O'Reilly. ISBN 978-0-596-00148-3.

External links

• help | Microsoft Docs