[PR #732] [FEATURE] Scripts to generate CCExtractor Man-page . #1554

Open
opened 2026-01-29 17:17:10 +00:00 by claunia · 0 comments
Owner

Original Pull Request: https://github.com/CCExtractor/ccextractor/pull/732

State: closed
Merged: No


Please prefix your pull request with one of the following: [FEATURE] [FIX] [IMPROVEMENT].

In raising this pull request, I confirm the following (please check boxes):

  • I have read and understood the contributors guide.
  • I have checked that another pull request for this purpose does not exist.
  • I have considered, and confirmed that this submission will be valuable to others.
  • I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  • I give this submission freely, and claim no ownership to its content.

My familiarity with the project is as follows (check one):

  • I have never used CCExtractor.
  • I have used CCExtractor just a couple of times.
  • I absolutely love CCExtractor, but have not contributed previously.
  • I am an active contributor to CCExtractor.

Added scripts to generate CCExtractor man-page using ccextractor --help. Also updated other scripts accordingly to include ccextractor.man while installing or creating packages.
Fixes sub part of issue #678

EDIT
Removed the scripts, added --man parameter to CCExtractor itself.
Squashed the commits.
Though it incurs a small size dependency help2man tool but it generates fairly good manpage as compared to writing output of print_usage directly to file and then changing the formatting of text (Adding sections like NAME, SYNOPSIS, TITLE) manually.
Though the task can be done without the tool but the text formatting using C would be more lines of code to maintain whenever the contents of print_usage() are changed.

**Original Pull Request:** https://github.com/CCExtractor/ccextractor/pull/732 **State:** closed **Merged:** No --- Please prefix your pull request with one of the following: **[FEATURE]** **[FIX]** **[IMPROVEMENT]**. **In raising this pull request, I confirm the following (please check boxes):** - [x] I have read and understood the [contributors guide](https://github.com/CCExtractor/ccextractor/blob/master/.github/CONTRIBUTING.md). - [x] I have checked that another pull request for this purpose does not exist. - [x] I have considered, and confirmed that this submission will be valuable to others. - [x] I accept that this submission may not be used, and the pull request closed at the will of the maintainer. - [x] I give this submission freely, and claim no ownership to its content. **My familiarity with the project is as follows (check one):** - [ ] I have never used CCExtractor. - [x] I have used CCExtractor just a couple of times. - [ ] I absolutely love CCExtractor, but have not contributed previously. - [ ] I am an active contributor to CCExtractor. --- Added scripts to generate CCExtractor man-page using `ccextractor --help`. Also updated other scripts accordingly to include `ccextractor.man` while installing or creating packages. Fixes sub part of issue #678 **EDIT** Removed the scripts, added `--man` parameter to CCExtractor itself. Squashed the commits. Though it incurs a small size dependency `help2man` tool but it generates fairly good manpage as compared to writing output of `print_usage` directly to file and then changing the formatting of text (Adding sections like NAME, SYNOPSIS, TITLE) manually. Though the task can be done without the tool but the text formatting using C would be more lines of code to maintain whenever the contents of `print_usage()` are changed.
claunia added the pull-request label 2026-01-29 17:17:10 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/ccextractor#1554