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.

Sign up for GitHub

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

Jump to bottom

Add note about using stdout #44

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add note about using stdout #44

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e3259e9
stdout help
Rushmore75 Aug 20, 2023
2bf75f8
Added manpage
Rushmore75 Sep 1, 2023
80aa266
Created a manpage
Rushmore75 Sep 1, 2023
52130b3
Updated README to mention the avaliablility of a man page.
Rushmore75 Sep 1, 2023
00580d1
Changed helptext
Rushmore75 Sep 2, 2023
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
2 changes: 1 addition & 1 deletion src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ mod xwrap;
use crate::xwrap::Display;

fn usage(progname: &str, opts: getopts::Options) {
let brief = format!("Usage: {progname} [options] [file]");
let brief = format!("Usage: {progname} [options] [file]\nNote: use - as [file] for stdout");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is the right place to document this, the help text should probably be reworked a bit to accommodate this. Ideally, the [file] positonal argument should have its own entry above the options section describing its behavior (both normal and special).
Also, since you're changing the help text, you have to update the readme to match.

let usage = opts.usage(&brief);
eprint!("{usage}");
}
Expand Down