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

bug: Problems with man pages #981

Open
j-xella opened this issue May 10, 2024 · 3 comments
Open

bug: Problems with man pages #981

j-xella opened this issue May 10, 2024 · 3 comments
Labels
errors Something isn't working good first issue Good for newcomers

Comments

@j-xella
Copy link

j-xella commented May 10, 2024

Those are the ones I spotted right away, if there are more, please add in comments.

  1. There is no documentation for --absolute option
  2. Man pages contain $version string, which I think should be replaced with an actual eza version number
  3. in "SEE ALSO" section, man pages still point to markdown files, for example eza_colors.5.md . The .md suffix should be removed in man pages.
@j-xella j-xella added the errors Something isn't working label May 10, 2024
@cafkafk
Copy link
Member

cafkafk commented May 13, 2024

Thanks for noting these down, those should definitely be fixed :D

@cafkafk cafkafk added the good first issue Good for newcomers label May 13, 2024
@gierens
Copy link
Member

gierens commented May 13, 2024

About the version thingy, I believe the problem is somewhere in the nix code because the Justfile which I'm using to generate the man pages for the deb packages seems to work.

@tartley
Copy link

tartley commented Jun 3, 2024

The man page currently contains:

-w, --width=COLS : Set screen width in columns.

Valid options are none, absolute or relative. The default value is none

absolute mode highlights based on file modification time relative to the past year. relative mode highlights based on file modification time in relation to other files. none disables highlighting.

I don't think the 2nd and 3rd paragraphs are relevant to the 1st, and I don't think they make any sense (to me) on their own. Perhaps they are meant to occur elsewhere? Or did something get deleted from after the 1st para?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
errors Something isn't working good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants