Man pages #672
Man pages #672
Conversation
|
((Tip 4 is such very beautiful but so much deleted in the end, lol)) |
|
Wow, thank you for this! The main manpage |
|
Ah, I had misunderstood what you were asking permission for. Yes please go ahead with the reformatting of the flags according to the best practices that you've cited. |
|
Is there anything I can help with here? |
|
Hold on, I am literally working on it. Just got back to it since yesterday. |
ratijas
force-pushed
the
man-pages
branch
3 times, most recently
from
aea2f45
to
9b1e9b3
Compare
|
ratijas, go home, u r drunk here are some screenshots of Before|After:
o hey, there's my Kid Icarus: Uprising desktop background, because Arc Dark theme in Konsole sucks without background transparency effect. happy new year and wish you a marry xmas btw (even if it's orthodox one). |
|
Those changes look wonderful! |
|
I'll give this a manual test and then merge if everything looks alright. |
At least groff manuals advice use of 'almost-empty' lines instead of completely blank lines, and that has something to do with vertical layout, which might end up stretched or whatever.
According to groff_man(7), text following .SH is set to .PP anyway, which makes explicit paragraphs redundant.
This way groff restores (P)revious font (which is bold here) of the heading instead of forcing it to become (R)oman (regular).
Fixes most flashy formatting errors where the whole description of an option becomes bold if font is not restored appropriately.
Leave it be, it is nice and readable.
Uses advanced groff_man(7) formatting requests to layout examples with their tags.
This example became literally useless since the introduction of `-Ss --both` search sub-option.
Copy-pasted style from pacman(8) and pacman.conf(5).
Using .EX/EE requests is equivalent to .nf + .nh and also should set font to monospace in e.g. HTML output device. Double-indented (RSAMPLE/ERSAMPLE) macro will be used for nested paragraphs in later commits.
* use .TP (with default indent) instead of `.RS 4`; * use .TS/.TE and tbl(1) preprocessor for table data; * use bulleted list in PRO TIPS section; * spread paragraphs using empty request lines for visual clarity.
|
Completely rewrote git history, so it supposed to make more sense now. But what do I know? I'm still drunk AF, it doesn't make any sense to me either way. Namely: squashed multiple changes to the same chunks and redundant micro-commits. Also, removed dot at the end of SEE ALSO section, since this seems to be more canonical way. And also this readability buff: diff --git a/aura/doc/aura.8 b/aura/doc/aura.8
index 6e671b7..4f0ea8e 100644
--- a/aura/doc/aura.8
+++ b/aura/doc/aura.8
@@ -648,7 +648,8 @@ You can then install it whenever you want with
.
Research packages using
.BR \-Ad \ ( \-\-deps ),
-.BR \-Ai \ ( \-\-info ") and "
+.BR \-Ai \ ( \-\-info )
+and
.BR \-Ap \ ( \-\-pkgbuild )!
.
.IP \(bu 2nOtherwise, it's the same candy just in a different wrapper. |
* use bold for options and italic for arguments; * prefer macros over inline fonts changes; * reword some descriptions, but nothing serious to worry about. PS ratijas is [[maybe] not so] lazy little piece of sh|t after all. The proof is trivial and left as an exercise for him.
|
hi @fosskers, how it's going with moving countries? c: For whatever reason, GitHub still thinks that changes are requested, but they actually were resolved long ago, so this shouldn't be an issue. |
|
Rest assured I haven't forgotten about this. I'm preparing to vacate my apartment on Sunday, and things are quite a mess at the moment as you might imagine. |
|
Oh yeah, it's harsh. I moved countries a bit while studying at universities, so I kinda know what you're talking about. Btw, just got my first job week ago, still can't get used to the early morning schedule. About man pages. You can view individual files with this command: while true; do man -l aura.8; sleep 1; done(sleep 1 is good for your health, it's very important for being able to wake up). |
|
I have successfully moved and am now reviewing the PR in earnest. |
|
Thanks again! |
|
Glad to see you are alright! LMAO, can't believe you really merged all those commit messages unchanged. That's a good stuff. And I have just received my new shiny hacktoberfest t-shirt. Is it just a coincidence? Hmm… |
|
I'm not a fan of rewriting history. Each commit represents effort and shows the overall process. |
Just some minor quality-of-life improvements.
@fosskers May I have your permission to rewrite these man pages into more canonical form suggested by groff_man(7)? What do I mean by this is:
.TPmacro for options,.B,.Ietc. extensively instead of inline font escapes (\fN) -- mostly because double click source text selection sucks with\fIinline \fBgroff\fRescapes,Ideally, I'd like to rewrite everything in
-mdocgroff_mdoc(7) instead of-man, because mdoc provides a semantic markup instead of direct font manipulation. But it looks so complex at first glance, that most of the world sticks with plain old groff_man(7).So basically, I'm a lazy
-Assloafer, who could have done this PR literally two month ago, but instead invested time into studying groff, contributing to GNU and doing loadshit of irrelevant stuff, up to the point of designing full-brown syntax highlighter & plugin for Sublime Text, when in fact all I originally wanted to do is to fix those damn closing brackets sections headers ( ec870fc ).Shame on me, it should have been hacktoberfest contribution, but whatever. I've completed the challenge by other means anyways.