Abra manpage for the win #590

New Issue

decentral1se · 2024-03-28T22:14:00Z

decentral1se commented

2024-03-28 22:14:00 +00:00

With examples, some stuff from docs, long-form, whatever seems reasonable.

From the speedrun! https://hack.allmende.io/2024-03-28-coopcloud-speedrun

With examples, some stuff from docs, long-form, whatever seems reasonable. From the speedrun! https://hack.allmende.io/2024-03-28-coopcloud-speedrun

decentral1se added the

enhancement

label 2024-03-28 22:14:00 +00:00

decentral1se added the

abra

label 2024-03-29 08:39:06 +00:00

3wordchant added the

documentation

label 2024-03-30 19:11:54 +00:00

3wordchant commented

2024-03-30 19:14:31 +00:00

Is there a way to add manpages for user commands, or do we need abra installed system-wide (as root)?

At least on my system, man only seems to search /usr/local/share/man/ and /usr/share/man/.

One possible alternative/addition could be to contribute some examples for abra to tldr

Is there a way to add manpages for user commands, or do we need abra installed system-wide (as `root`)? At least on my system, `man` only seems to search ` /usr/local/share/man/` and `/usr/share/man/`. One possible alternative/addition could be to contribute some examples for `abra` to [`tldr`](https://github.com/tldr-pages/tldr)

decentral1se commented

2024-03-31 00:20:33 +00:00

Well, it seems like urfave/cli supports this in #830 and we can generate markdown and manpage formats. We could include that markdown file on docs.coopcloud.tech? 🤔

As for where it should go... I was reading https://tldp.org/HOWTO/Man-Page/q2.html and https://www.baeldung.com/linux/man-pages-manual-install. Does running manpath give you back something that would work for "not root" user? Mine does... (Debian)

Unsure what we could automate here but wget/curl'in the files down into a user local location could be nice if it is cross platform. That's be more or less what we do for the autocomplete stuff.

Well, it seems like `urfave/cli` supports this in [`#830`](https://github.com/urfave/cli/pull/830) and we can generate markdown and manpage formats. We could include that markdown file on docs.coopcloud.tech? 🤔 As for where it should go... I was reading https://tldp.org/HOWTO/Man-Page/q2.html and https://www.baeldung.com/linux/man-pages-manual-install. Does running `manpath` give you back something that would work for "not root" user? Mine does... (Debian) Unsure what we could automate here but `wget`/`curl`'in the files down into a user local location could be nice if it is cross platform. That's be more or less what we do for the `autocomplete` stuff.

3wordchant commented

2024-03-31 00:33:29 +00:00

Does running manpath give you back something that would work for "not root" user? Mine does... (Debian)

Ah great call I tried to find a way to check that but didn't.

$ manpath
/home/f/Applications/pyenv/man:/home/f/Applications/basher/cellar/man:/usr/local/share/man:/usr/share/man

So obviously some stuff has found a way to add to my manpath, but grep MAN ~/.config/bashrc ~/.bashrc turns up nothing so i've got no neat advice how to do it.

Unsure what we could automate here but wget/curl'in the files down into a user local location could be nice if it is cross platform. That's be more or less what we do for the autocomplete stuff.

V cool yeah!

> Does running `manpath` give you back something that would work for "not root" user? Mine does... (Debian) Ah great call I tried to find a way to check that but didn't. ``` $ manpath /home/f/Applications/pyenv/man:/home/f/Applications/basher/cellar/man:/usr/local/share/man:/usr/share/man ``` So obviously some stuff has found a way to add to my manpath, but `grep MAN ~/.config/bashrc ~/.bashrc` turns up nothing so i've got no neat advice how to do it. > Unsure what we could automate here but `wget`/`curl`'in the files down into a user local location could be nice if it is cross platform. That's be more or less what we do for the `autocomplete` stuff. V cool yeah!

decentral1se commented

2024-12-26 19:24:16 +00:00

spf13/cobra supports this. I've got a working prototype in coop-cloud/abra#452 which needs some polishing. My only question is: is /usr/local/share/man/man1 a reliable place to dump generated man pages across different distributions?

What I'm doing so far:

# punt generation into /usr/local/share/man/man1
sudo abra man  

# reload man pages index
sudo mandb 

# read shit
man abra
man abra-app-deploy

`spf13/cobra` [supports this](https://github.com/spf13/cobra/blob/main/site/content/docgen/man.md). I've got a working prototype in https://git.coopcloud.tech/coop-cloud/abra/pulls/452 which needs some polishing. My only question is: is `/usr/local/share/man/man1` a reliable place to dump generated man pages across different distributions? What I'm doing so far: ```bash # punt generation into /usr/local/share/man/man1 sudo abra man # reload man pages index sudo mandb # read shit man abra man abra-app-deploy ```

decentral1se referenced this issue from toolshed/abra

2024-12-26 19:42:10 +00:00

refactor!: `spf13/cobra` migrate #452

decentral1se closed this issue

2024-12-27 12:38:07 +00:00

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: toolshed/organising#590