Rewrite terminator.1 man page in AsciiDoc format#733
Merged
mattrose merged 3 commits intognome-terminator:masterfrom Mar 31, 2023
Merged
Rewrite terminator.1 man page in AsciiDoc format#733mattrose merged 3 commits intognome-terminator:masterfrom
mattrose merged 3 commits intognome-terminator:masterfrom
Conversation
added 3 commits
March 29, 2023 23:59
1. Decapitalize some words 2. Replace 'Hide/Show' with 'Toggle' 3. Replace 'AUTHOR' with 'AUTHORS' 4. Move the 'SEE ALSO' section to the bottom
Member
|
Documentation Improvements!? You're awesome, thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
terminator.1is the man page that opens after typingman terminator.It currently contains a few problems, such as a missing newline, options and their arguments being all in bold instead of bold and italic, keybindings out of place or in the wrong sub-section...
All of that should now be fixed.
The AsciiDoc format seems to me way more friendly than the manpage one.
To generate the manpage file, we just need to run
asciidoctor -b manpage terminator.adocafter modifying the source.Maybe it would be a good idea to add a script that runs that command.
I've started working on a manpage for remotinator as well. And ideally,
terminator_configshould be rewritten too, but that requires way more work and updates.