search

atom / atom

:atom: The hackable text editor
https://atom.io
MIT License
60.27k stars 17.4k forks source link

Man pages for atom and apm #5430

Open xfq opened 9 years ago

xfq commented 9 years ago

Besides the --help and -h command line options/arguments, atom and apm should also have man pages. Moreover, Emacs and Vim have online documentation for their command line arguments and/or environment variables, too:

thedaniel commented 9 years ago

Yeah, this would be great.

gibsjose commented 9 years ago

+1. Is this still on anyone's radar? man pages for apm seem like a given. Not sure about how useful they would be for atom itself, though.

maazghani commented 8 years ago

+1 Would also like this.

Alhadis commented 8 years ago

On it.

Not sure whereabouts to stick the man-page when I've finished writing it, though... @maxbrunsfeld, is making a new base directory called man okay? Seems like overkill for one file.

thomasjo commented 8 years ago

when I've finished writing it

@Alhadis I really think we should generate the man page, not write it. Keeping it up to date manually is not worth the cost/benefit IMHO. We're already using yargs for our command line parsing, and it should be possible to generate a man from these bits: main.coffee#L99-L139

/cc @atom/feedback

thomasjo commented 8 years ago

@Alhadis Check out https://github.com/rtomayko/ronn.

iainhallam commented 8 years ago

Seems nobody did. Would a simple output of --help be enough for now?

stale[bot] commented 6 years ago

Thanks for your contribution!

This issue has been automatically marked as stale because it has not had recent activity. Because the Atom team treats their issues as their backlog, stale issues are closed. If you would like this issue to remain open:

  1. Verify that you can still reproduce the issue in the latest version of Atom
  2. Comment that the issue is still reproducible and include:
    • What version of Atom you reproduced the issue on
    • What OS and version you reproduced the issue on
    • What steps you followed to reproduce the issue

Issues that are labeled as triaged will not be automatically marked as stale.

iainhallam commented 6 years ago

Still no man pages included with the RPM as of 1.26.1 on CentOS 7.4.

TriMoon commented 5 years ago

If this package wants to be in the default debian distribution, which it belongs IMHO, it should:

Debian Policy Manual §12.1. Manual pages

Each program, utility, and function should have an associated manual page included in the same package. It is suggested that all configuration files also have a manual page included as well. Manual pages for protocols and other auxiliary things are optional.

If no manual page is available, this is considered as a bug and should be reported to the Debian Bug Tracking System (the maintainer of the package is allowed to write this bug report themselves, if they so desire). Do not close the bug report until a proper man page is available.

dmallia17 commented 4 years ago

I would love to tackle this issue with some classmates from an open source software development course if it is still of interest!

sadick254 commented 4 years ago

Hey @dmallia17 . Thank you for showing interest. Are you still open to work on this?