asdf-vm/asdf

What is the best practice for making man pages accessible that are installed via asdf?

Open

#263 创建于 2017年12月18日

在 GitHub 查看
 (12 评论) (5 反应) (0 负责人)Go (23,759 star) (881 fork)batch import
enhancementhelp wanted

描述

I've been using asdf for a little while now, and something I have noticed is that certain man pages for certain languages / tools aren't accessible after installing such language, i.e. elixir for example.

Presently I am using asdf v0.4.0 on macOS 10.12.6 and macOS does a little trickery to get the man pages loaded. For one, if a MANPATH environment variable is set the paths specified in /private/etc/man.conf are no longer searchable.

What does this mean? I.e. if I install the homebrew version of git it's manual / man page will become accessible via man git. However if I add say $HOME/.asdf/installs/elixir/1.5.2/man to an environment variable called MANPATH then I can no longer access the man page for git using the command man git.

The trivial solution that I have come up with is to symlink the $USER specific man pages for various languages I have installed via asdf to /usr/local/share/man which then makes them accessible, and I can run man elixir and man git.

However when I installed python 3.6.3 via asdf it was intelligent enough to add the man pages from my locally installed python and link them to the proper path. I have no idea how python set this up, is it something specific to python or something specific to the asdf-python version?

贡献者指南

技术栈
无
领域
developer experiencedocumentation
议题类型
research
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
familiarity with asdfunderstanding of man pagesknowledge of shell environment variables
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Investigate how asdf plugins currently handle man pages, particularly the asdf python plugin which seems to symlink automatically. Look at the asdf core documentation and plugin API to see if there is a recommended mechanism. Propose a standardized approach, possibly via a plugin hook or shim, that sets MANPATH correctly without breaking system man pages. Consider cross platform differences (macOS vs Linux). The discussion in the issue may contain viable workarounds.