Man page

[jovanbulck]

For Linux users, we should have a man page with all the info from the readme, wiki and --help flag in a readable and coherent form; (note: all info from the man page should also be available on the wiki, e.g. through a text dump of the man page)

It should come with an installation script (Makefile or so) that installs kotnetcli under /usr/local/bin and the man page under /usr/local/share/man/man1

The Makefile and/or dialog-based installer shell script of the jsh shell could be a good place to start

Marking this for release 3.0.0 'Cape Cod' ?

[jovanbulck]

the installer could also help the user to resolve dependencies

[GijsTimmers]

I completely agree on the necessity of a man page. Some of my thoughts on the installer:

• I think that the Linux repository system is one of its biggest advantages compared to other operating systems. Although it may be hard to get kotnetcli into, say, the Ubuntu repositories, we could at least 'hook into it' by using .deb and .rpm files, which are very to install in modern distributions. For Arch, it will probably be easier: we can just create an AUR entry. In my opinion, this is cleaner than writing a separate installer.
• Of course, a NSIS installer would be a very interesting choice for Windows users.
• Another very interesting thing would be to upload kotnetcli as a PyPI package, so that users could install kotnetcli via pip. Considering that all kotnetcli dependancies are installable through pip, it would be very cool to see pip pull in all the necessary dependancies and then put the kotnetcli files into the $PATH.

[jovanbulck]

Another very interesting thing would be to upload kotnetcli as a PyPI package,

I like this idea :-) It would also be cross-platform

[GijsTimmers]

I've been looking around for some pointers on how to create a $PATH executable for PyPI packages.

Seems like the most common way to do it is using the entry_points statement along with console_scripts.

What this basically does, is linking an executable in $PATH to a specific function in your package.

Please note that kotnetcli reads command-line-arguments when executed. Linking an executable to a function will therefore result in not being able to parse command-line arguments. An example of this problem can be found here.

I'm not sure what the right approach to this will be.

Some other programs that use entry_points:

• grip
• mps-youtube
• keyring

[GijsTimmers]

The PyPI stuff is as good as done. Can you do the man page stuff?

[jovanbulck]

The PyPI stuff is as good as done. Can you do the man page stuff?

Writing the man page itself is not a lot of work, but we'll have to keep it up-to-date. Moreover, the --help output is rather self-contained and readable. My original proposal for a man page is therefore not needed anymore. In my opinion you can close this issue for now..

[GijsTimmers]

Alright, closing