diff options
| author | jcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524> | 2013-03-04 21:54:02 +0000 |
|---|---|---|
| committer | jcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524> | 2013-03-04 21:54:02 +0000 |
| commit | 365aa98a5dfba45b7ecfe04495cb28e9e05d2a45 (patch) | |
| tree | 3a13e86c98a2ae6829c09483c944c819ac6f0c95 /ShellPkg/Include | |
| parent | fb2ae5fdb5207233e9be8f73d552860d9169fa8e (diff) | |
| download | edk2-365aa98a5dfba45b7ecfe04495cb28e9e05d2a45.tar.gz edk2-365aa98a5dfba45b7ecfe04495cb28e9e05d2a45.tar.bz2 edk2-365aa98a5dfba45b7ecfe04495cb28e9e05d2a45.zip | |
ShellPkg: Add ShellPrintHelp function to ShellLib.
This function allows for easier access to printing standard command help.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Matt Stanbro <Matthew.A.Stanbro@intel.com>
Reviewed-by: Jaben Carsey <Jaben.carsey@intel.com>
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@14159 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'ShellPkg/Include')
| -rw-r--r-- | ShellPkg/Include/Library/ShellLib.h | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/ShellPkg/Include/Library/ShellLib.h b/ShellPkg/Include/Library/ShellLib.h index a1b534bd3e..eefa030ad1 100644 --- a/ShellPkg/Include/Library/ShellLib.h +++ b/ShellPkg/Include/Library/ShellLib.h @@ -1357,4 +1357,23 @@ ShellDeleteFileByName( IN CONST CHAR16 *FileName
);
+/**
+ Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.
+
+ @param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.
+ @param[in] SectionToGetHelpOn Pointer to the section specifier(s).
+ @param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints
+ the help content only.
+ @retval EFI_DEVICE_ERROR The help data format was incorrect.
+ @retval EFI_NOT_FOUND The help data could not be found.
+ @retval EFI_SUCCESS The operation was successful.
+**/
+EFI_STATUS
+EFIAPI
+ShellPrintHelp (
+ IN CONST CHAR16 *CommandToGetHelpOn,
+ IN CONST CHAR16 *SectionToGetHelpOn,
+ IN BOOLEAN PrintCommandText
+ );
+
#endif // __SHELL_LIB__
|