Opened 11 months ago

Last modified 11 months ago

#24288 new defect

install process does not include man page

Reported by: stefani Owned by: atagar
Priority: Low Milestone:
Component: Core Tor/Nyx Version:
Severity: Normal Keywords: manual, configuration
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

installation of nyx could place the nyx.1 man page in /usr/local/man/man1/ for example.
optional would be a nyxrc example file with commented-out defaults

Child Tickets

Attachments (1)

config (3.6 KB) - added by stefani 11 months ago.
possible nyx config file based on web page https://nyx.torproject.org/#configuration

Download all attachments as: .zip

Change History (6)

comment:1 Changed 11 months ago by stefani

Priority: MediumLow

Changed 11 months ago by stefani

Attachment: config added

possible nyx config file based on web page https://nyx.torproject.org/#configuration

comment:2 Changed 11 months ago by stefani

added possible config file based on nyx configuration page.

comment:3 Changed 11 months ago by atagar

Hi stefani. Nyx provides both a man page and nyxrc.sample [1], but installation of them depend on the platform package. Different distros differ on where these should go. As such it's up to the deb, rpm, bsd port, etc. What platform are you on?

[1] https://gitweb.torproject.org/nyx.git/tree/web/nyxrc.sample

comment:4 Changed 11 months ago by stefani

hola.
I didn't think to look in the /web directory for a nyxrc file, so did not see your sample.
I guess a /doc directory might have been more obvious to me. Same for the nyx.1 man page. and now that i think of it, a myxrc.8 man page

i'm running on a barebones debian. no web browser there.
question though: if setup.py knew default well enough to put nyx in /usr/local/bin there must be other similar defaults for man and doc and config examples; /usr/local/etc/nyxrc

comment:5 Changed 11 months ago by atagar

Nyx used to. Gentoo wanted something different so I added a '--man-page' and '--sample-path' argument to our setup.py. But the custom installer caused problems for our latest release...

https://gitweb.torproject.org/nyx.git/commit/?id=b89f6ca

I'd be delighted to take a patch that adds them back. Now that we use setuptools rather than distutils it might not be so tricky.

The reason the nyxrc.sample is in the web directory is so folks can download it from https://nyx.torproject.org/nyxrc.sample. We can add a symlink if you need it elsewhere.

Note: See TracTickets for help on using tickets.