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

Man page improvement #1827

Closed
ralsina opened this issue Jun 16, 2015 · 7 comments
Closed

Man page improvement #1827

ralsina opened this issue Jun 16, 2015 · 7 comments
Assignees
Milestone

Comments

@ralsina
Copy link
Member

@ralsina ralsina commented Jun 16, 2015

The current man page is the barely necessary to say "we have a man page".

It could be improved by showing the help of each subcommand. Maybe a --help --long that expands each one?

@ralsina

This comment has been minimized.

Copy link
Member Author

@ralsina ralsina commented Jun 16, 2015

@schettino72 maybe this would be good for doit, too, want me to try doing a PR there?

@schettino72

This comment has been minimized.

Copy link
Member

@schettino72 schettino72 commented Jun 16, 2015

The debian package provides a man page for doit. I actually dont care at all about man pages for doit. No user ever complained about that. And I guess it would just be an extra hassle to deal with it in setuptools.

Said that, I would be ok to add a man page as long as its creation is completely automated.

Thanks!

@Kwpolska

This comment has been minimized.

Copy link
Member

@Kwpolska Kwpolska commented Jun 16, 2015

IMO automated man pages are not a good idea. A man page that shows the help of each subcommand is going to help no-one. I would personally have a human-written man page that is a short introduction to Nikola, along with descriptions of commands. We could start by taking the handbook and editing it down.

@ralsina

This comment has been minimized.

Copy link
Member Author

@ralsina ralsina commented Jun 16, 2015

I have no intention to ever learn how to write man pages. So it's either going to be something using rst2man or help2man.

We have at least one user for whom running nikola itself is too slow to use the help command :-P

<polyzen> :p nikola help bootswatch_theme  22.98s user 0.88s system 90% cpu 26.281 total

But I agree that's totally a corner case.

@schettino72

This comment has been minimized.

Copy link
Member

@schettino72 schettino72 commented Jun 16, 2015

bootswatch_theme is a command or a task? Yes, 20 seconds is not acceptable. Why it takes that long? This should be fixed...

@ralsina

This comment has been minimized.

Copy link
Member Author

@ralsina ralsina commented Jun 16, 2015

It's a command. It only takes that long for him because he's trying to run this in a Rpi, where disk access uses CPU :-P

@schettino72

This comment has been minimized.

Copy link
Member

@schettino72 schettino72 commented Jun 16, 2015

OK. I see #1825. I will comment there :)

@Kwpolska Kwpolska self-assigned this Jun 23, 2015
@Kwpolska Kwpolska added the PR exists label Jun 23, 2015
@Kwpolska Kwpolska closed this in 2d4b05a Jun 24, 2015
Kwpolska added a commit that referenced this issue Jun 24, 2015
Fix #1827 -- human-written manpage
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.