Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Option to use Pager to display help text #216

Merged
merged 2 commits into from
Feb 22, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/CommandLineUtils/CommandLineApplication.cs
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,11 @@ public string Name
/// </summary>
public List<CommandOption> Options { get; private set; }

/// <summary>
/// Whether a Pager should be used to display help text.
/// </summary>
public bool UsePagerForHelpText { get; set; } = true;

/// <summary>
/// All names by which the command can be referenced. This includes <see cref="Name"/> and an aliases added in <see cref="AddName"/>.
/// </summary>
Expand Down Expand Up @@ -839,7 +844,7 @@ public virtual void ShowHint()
/// <summary>
/// Show full help.
/// </summary>
public void ShowHelp() => ShowHelp(usePager: true);
public void ShowHelp() => ShowHelp(usePager: UsePagerForHelpText);

/// <summary>
/// Show full help.
Expand Down