tldr

B

balanga

Has anyone ever cpme across tldr, and is it something which can be used on FreeBSD?

According to https://tldr.sh/ you can install it using

Installation​

As of now, our most mature client is the Node.js one, which you can easily install from npm:

npm install -g tldr

What does this actually mean?

Just out of interest I tried pkg install -y npm and have managed to install

Code: 
    c-ares: 1.21.0
    node20: 20.9.0
    npm: 10.2.2
    npm-node20: 10.2.2

Number of packages to be installed: 4

And voila, npm install -g tldr now works. Not sure where this will lead, but let's find out...
 
Here is an initial test:-

Code: 
root@X1:~ # tldr tar

  tar

  Archiving utility.
  Often combined with a compression method, such as gzip or bzip2.
  More information: https://www.gnu.org/software/tar.

  - [c]reate an archive and write it to a [f]ile:
    tar cf path/to/target.tar path/to/file1 path/to/file2 ...

  - [c]reate a g[z]ipped archive and write it to a [f]ile:
    tar czf path/to/target.tar.gz path/to/file1 path/to/file2 ...

  - [c]reate a g[z]ipped archive from a directory using relative paths:
    tar czf path/to/target.tar.gz --directory=path/to/directory .

  - E[x]tract a (compressed) archive [f]ile into the current directory [v]erbosely:
    tar xvf path/to/source.tar[.gz|.bz2|.xz]

  - E[x]tract a (compressed) archive [f]ile into the target directory:
    tar xf path/to/source.tar[.gz|.bz2|.xz] --directory=path/to/directory

  - [c]reate a compressed archive and write it to a [f]ile, using the file extension to [a]utomatically determine the compression program:
    tar caf path/to/target.tar.xz path/to/file1 path/to/file2 ...

  - Lis[t] the contents of a tar [f]ile [v]erbosely:
    tar tvf path/to/source.tar

  - E[x]tract files matching a pattern from an archive [f]ile:
    tar xf path/to/source.tar --wildcards "*.html"

I guess it's only to be expected that it uses GNUtar rather than BSDtar, but maybe it worth persevering with...
 
Only thing is this could result in negative effects, such as attracting the type of user who needs his/her hand held. We need less of that, not more. The manual pages are already simplified.
 
This was partly for FreeBSD:

github.com

freebsd, netbsd: add directory; pkg, pkgin: add page by acuteenvy · Pull Request #11313 · tldr-pages/tldr

The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc. The page(s) have at most 8 examples. The page description(s) have links to documentation or ...
github.com github.com

balanga said:
And voila, npm install -g tldr now works. Not sure where this will lead, but let's find out...
Click to expand...

Sweet!

Code: 
root@mowa219-gjp4-8570p-freebsd:~ # npm install -g tldr

added 78 packages in 33s

18 packages are looking for funding
  run `npm fund` for details
npm notice
npm notice New patch version of npm available! 10.2.2 -> 10.2.3
npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.2.3
npm notice Run npm install -g npm@10.2.3 to update!
npm notice
root@mowa219-gjp4-8570p-freebsd:~ # npm install -g npm@10.2.3

changed 14 packages in 13s

26 packages are looking for funding
  run `npm fund` for details
root@mowa219-gjp4-8570p-freebsd:~ # uname -KU
1500003 1500001
root@mowa219-gjp4-8570p-freebsd:~ #

Result:

Code: 
% tldr pkg
✔ Page not found. Updating cache...
✔ Creating index...
Command pkg does not exist for the host platform. Displaying the page from android platform

…

Discussion: <https://matrix.to/#/!zXiOpjSkFTvtMp...via=gitter.im&via=matrix.org&via=one.ems.host>


I might make something to complement geli(8).
 
You must log in or register to reply here.
Back
Top