Comments (2)
The man-page in my opinion needs to be an explanation of what certain features in the program does and perhaps even explain why they work that way. For example, I was confused by what Closure Size
and NAR Size
meant when I first started using the program. (never came across those terms before now, which explains the reason for my confusion)
The style of the man-pages could also be of a TL;DR style to not have people become bored of the man-pages while reading it and instead retain that information in the GitHub repository if so desired.
And for how you could style the man-page, take a look at man nix
. :)
from nix-tree.
Thank you, I do think this would be very useful.
I believe it'd be easy to implement this technically as you suggested:
- We populate
man nix-tree
nix-tree --help
would executeman nix-tree
instead- Help shortcut in nix-tree can also open the man page, and exiting it would go back to the application
- I think with your other suggestion on #49 , the contents of the help modal right now would become redundant anyway.
But I guess I do not have a clear idea on what that man page should look like. Currently nix-tree have some docs here: https://github.com/utdemir/nix-tree#usage . They don't seem enough to be, but I'm unsure what else I should add. Do you have any ideas? What kind of structure does that man-page needs?
from nix-tree.
Related Issues (20)
- Restore flakes support? HOT 1
- Freeze when using "yank" function HOT 8
- Reverse dependencies (`--query --referrers`) HOT 10
- Add support for flake syntax, like `nixpkgs#hello` HOT 3
- Feature request: browse output directories and source input directories HOT 4
- Feature request: Help diagnose packages with file collisions HOT 2
- Feature request: inspect raw derivation HOT 2
- Reproducible hanging HOT 2
- Feature request: impure flag HOT 1
- Feature request: Have the ability to show closure size when using --derivation HOT 1
- Feature request: display bindings in the lower right corner of `nix-tree`. HOT 4
- Feature request: Hide a closure from search results HOT 1
- Unable to see the dependencies of pandoc flake HOT 1
- Feature request: graphviz export HOT 2
- Feature request: add `--file` flag
- Segmentation fault when hitting key binding before progress bar starts HOT 7
- Support new path-info syntax introduced in nix 2.19 HOT 2
- nix-tree is broken with nix 2.19 HOT 1
- What does the color coding mean? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from nix-tree.