tldr-pages / tldr Goto Github PK

Hi @felixonmars, @edgurgel, @danzimm, @pranavraja.

As suggested by @shrayas, I moved tldr and tldr-node-client to a new tldr-pages organisation. Let me know if you want to move the other clients over there too, so they're easy to find. I'll make sure you have admin rights on the repos over there!

It looks like there is something wrong on https://registry.npmjs.org/tldr/-/tldr-0.0.5.tgz - I'll get a {"error":"not_found","reason":"Document is missing attachment"}

0.0.4 is available and can be installed with npm.

npm install -g tldr
npm http GET https://registry.npmjs.org/tldr
npm http 304 https://registry.npmjs.org/tldr
npm http GET https://registry.npmjs.org/tldr/-/tldr-0.0.5.tgz
npm http 404 https://registry.npmjs.org/tldr/-/tldr-0.0.5.tgz
npm ERR! fetch failed https://registry.npmjs.org/tldr/-/tldr-0.0.5.tgz
npm ERR! Error: 404 Not Found
...

In a cursory look through this repository, there is no license available. This means that contributors will be skittish, redistributors will be punishable under U.S. and other copyright law, and don't even get me started about redistributing modified copies.

Please say something about a license in your README, include the full text of the license you choose in a COPYING file, and (ideally) add copyright and license headers in each file in the project.

Thanks!

tldr --platform gnu ln

Each platform uses its own version of a tool (BSD vs GNU, for instance), but in some cases the native platform version may be superseded by another version. (Related to #61)

OS X uses BSD ln

os x$ ln -h
usage: ln [-Ffhinsv] source_file [target_file]
       ln [-Ffhinsv] source_file ... target_dir
       link source_file target_file

Linux tends to use GNU ln

gnu$ ln --help
Usage: ln [OPTION]... [-T] TARGET LINK_NAME   (1st form)
  or:  ln [OPTION]... TARGET                  (2nd form)
  or:  ln [OPTION]... TARGET... DIRECTORY     (3rd form)
  or:  ln [OPTION]... -t DIRECTORY TARGET...  (4th form)
In the 1st form, create a link to TARGET with the name LINK_NAME.
In the 2nd form, create a link to TARGET in the current directory.
In the 3rd and 4th forms, create links to each TARGET in DIRECTORY.
... and so on ...

SunOS uses SunOS ln

sunos$ /usr/bin/ln -h
/usr/bin/ln: illegal option -- h
ln: Insufficient arguments (0)
Usage: ln [-f] [-n] [-s] f1 [f2]
       ln [-f] [-n] [-s] f1 ... fn d1
       ln [-f] [-n] -s d1 d2

(Though in some SmartOS images, the ln tool is symlinked to GNU ln)

Could you do that? :)

I saw a way to install with npm, pip, and go, but was wondering if there was a way to set it up for Homebrew or Homebrew Cask for Mac/Unix.

Hi there guys,

Both amused by the tldr concept and eager to try out duo, I put this together as a simple test: https://github.com/leostera/tldr.js

I'll throw some styles to it as soon as I get some free time, and I think if the rate-limits from the github api can be worked around then this could be nice to have?

Anywho, cheers!

I am happy to see tldr now supports multi platforms. But when I run tldr zip, not found error was given. I used npm update to update tldr, but it is still not working. Maybe the new version is not published yet? But I am not able to check the version.

This is the result of doing tldr tar on my Ubuntu 13.04 :

ERROR: tar command not available
Consider contributing Pull Request to https://github.com/rprieto/tldr

Running the script manually (after cloning the project) this is what I get :

$ sudo ./bin/tldr tar

/home/polo/Work/testnode/tldr/lib/remote.js:13
    throw new Error('Sorry, your platform is not supported yet (' + os.platfor
          ^
Error: Sorry, your platform is not supported yet (linux)
    at osGroup (/home/polo/Work/testnode/tldr/lib/remote.js:13:11)
    at Object.exports.url (/home/polo/Work/testnode/tldr/lib/remote.js:6:36)
    at getRemote (/home/polo/Work/testnode/tldr/lib/request.js:16:20)
    at /home/polo/Work/testnode/tldr/lib/request.js:8:7
    at /home/polo/Work/testnode/tldr/node_modules/async/lib/async.js:485:30
    at /home/polo/Work/testnode/tldr/lib/cache.js:28:7
    at Object.oncomplete (fs.js:107:15)

Please consider supporting linux, or indicate if this is a Mac OS only tool in the README.

tldr is great, but I don't think hard coding the pages into markdown files is a far-reaching design. Maybe you can use a better and more flexible public service to store all these wisdom!

Can you change the dark red to light(er) red?

First thing I did when I tried it out tldr man . I don't know why, it was just a reaction

tldr should have Markdown styleguide because pages looks much better with same syntax. Also, there should be writing format.

Create, modify, and extract from archives (.a .so .o)

Examples :

ar -x libfoo.a

Extract members of the archive.

ar -t libfoo.a

List the content (files) of libfoo.a.

https://github.com/felixonmars/tldr-python-client

Just wrote an initial version, rather simple, but it works :p

Will add some highlighting feature soon.

@rprieto At month ago I installed tldr. Work perfect. But now I want have updates which was created. What should I do ?

Hey there,
I just came across tldr (thanks, The Changelog) and think that the idea is awesome!

I just had an idea that I think would be great for people to discover new command lines: tldr --random. It would show a tldr, randomly for your OS. One could have it executed maybe on Terminal's boot, or whatever.

What do you think? I did not look at the code, so I have no idea of the project's structure make it easy to do or not. Also, I have no clue if you think that would be useful or not.

Thanks!

Currently when I do:

tldr lsof

I get an error:

var FOLDER = path.join(os.tmpdir(), 'tldr-cache');
                          ^
TypeError: Object #<Object> has no method 'tmpdir'
    at Object.<anonymous> (/usr/local/lib/node_modules/tldr/lib/cache.js:8:27)
    at Module._compile (module.js:449:26)
    at Object.Module._extensions..js (module.js:467:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Module.require (module.js:362:17)
    at require (module.js:378:17)
    at Object.<anonymous> (/usr/local/lib/node_modules/tldr/lib/request.js:2:15)
    at Module._compile (module.js:449:26)
    at Object.Module._extensions..js (module.js:467:10)

Hi,

I want to merge a netstat tldr.
I am not sure how to go about getting it reviewed and creating merge request. Pls help.

Thanks,
Amit

How to disable the colorscheme of tldr ? As things stand, only the command lines are readable.

Tested with

• Konsole (that ships with Solarized Light by default),
• urxvt, and
• Xterm

Display information about ressources used in IPC (Inter-process Communication).

Examples :

ipcs -qi 32768

Specific infomration about the Message Queue witch has the id 32768

ipcs -a

General informations about all the IPC

see ipcrm to deallocate IPC ressources

Great project Romain, I really like the concise format of this documentation.

I wanted to see if it would be possible to implement a way to customize the output. As is the red on black example format is very difficult to read on my screen:

Hey,

Firstly, thanks for this, it's a fantastic idea.

It would be great if there was a some way in which to override the colour scheme used by tldr. Here is how it's currently looking in my terminal:

Cheers!

I tried

npm rm tldr.

It shows..

npm WARN uninstall not installed in /node_modules: "tldr"

By the way... I tried tldr tar also.

ERROR: tar command not available
Consider contributing Pull Request to https://github.com/rprieto/tldr

(Note for context: this issue was created with the title "Collaborate with bropages?")

It's quite unfortunate that there are two projects splitting the mindshare of easily approachable, community-maintained quick reference documents for console commands: tldr and bropages.

I didn't find signs of any past discussion, so I'd thought I'd mention the possibility and call the maintainers @rprieto and @hubsmoke (and all interested parties, of course) to go over the possibilities.

To kick things off, it might be worth discussing:

• the merits of the friendlier submission mechanism of bropages and the possibilities of tldr adopting such a workflow
• the many-competing-versions model of bropages versus the more wiki-like single-canonical-document model of tldr
• the possibility of developing a Ruby-based tldr client (done since #288)
• whether a web-based client like tldr.js connecting to both databases could be a nice first step towards greater integration

What do you guys think?

I can't get any command on Linux. :(

This is strange. I'm able to find the package in https://pypi.python.org/ , but if I try to install it using pip or easy_install, it fails saying it can't be found.
I'm under Ubuntu 13.04.

Commands output:

⮀ sudo pip install tldr
Downloading/unpacking tldr
  Could not find any downloads that satisfy the requirement tldr
No distributions at all found for tldr
Storing complete log in /home/fisa/.pip/pip.log

⮀ sudo easy_install tldr
Searching for tldr
Reading https://pypi.python.org/simple/tldr/
No local packages or download links found for tldr
error: Could not find suitable distribution for Requirement.parse('tldr')

(copied form the conversation at #147)

The current folder structure looks like:

pages
  |__ common
  |   |__ tar.md         # gnu command everyone should have
  |   |__ ssh.md         # gnu command everyone should have
  |   |__ npm.md         # just a tool that could be installed on any OS
  |__ linux
  |   |__ emerge.md      # clearly a linux-only tool
  |__ osx
      |__ ssh.md         #  OSX has a different version with different flags

This has worked so far, but

• the split can feel arbitrary
• you need to jump around to see if a command is already covered
• clients potentially need to make a lot of requests to get a given page

There seems to be a consensus among clients to move to a flatter folder structure, that would look like this:

pages
   |__ tar.md
   |__ ssh.md
   |__ ssh.osx.md
   |__ emerge.md
   |__ npm.md

By default, we can display <command>.md, but <command>.<os>.md should have precedence if available.

This means the clients would let OSX users query Linux commands, but after all why not, they might just be curious about it. Or they might be using tldr on a Mac while SSHing on a Linux box that doesn't have it.

To clear up platform constraints, the description for emerge for example could say "for Linux" or "Gentoo specific command".

This would be a breaking change though, so we need a plan of attack. One option is to address all open PRs to get to a stable state, then copy all pages to the new structure. The old structure can live on for a while until all clients update. The PR guidelines would say to push changes to the new structure only.

The pages can be separated into another git so users can write their own tldr command to show those pages.

Integrate that repo usint git submodule

ex: " or '

It would be nice if markit had an option to turn off escaping.

Just in case

I think non-OS specific things should be separated into a different category. For example, pacman can compile and run on BSD, so it's not specific to linux, and a lot of other unix-like programs can be cross-compiled.

However, things like ls and cd should be in the common category, but distro-specific things like dpkg and pacman should be in the apps category.

Rendering a local file fails like so on the npm version.

$ tldr --render test.md

/usr/local/lib/node_modules/tldr/lib/tldr.js:55
    console.log(output.fromMarkdown(fs.readFileSync(file) + ''));
                ^
ReferenceError: output is not defined
    at Object.exports.render (/usr/local/lib/node_modules/tldr/lib/tldr.js:55:17)
    at Object.<anonymous> (/usr/local/lib/node_modules/tldr/bin/tldr:54:42)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at startup (node.js:119:16)
    at node.js:929:3

$ cat test.md
#hi

how are you

- how
- is
- your
- day

For ex:

find {{root_path}} -name {{'*.py'}} -exec {{wc -l {}}} \;

The current token regex has a problem with {{wc -l {}}}, where it matches "closing" brackets too early.

am I just blind or isn't there a very quick install instruction in the readme, such as:
npm install -g tldr

you should definetly have one

Is the common pages just for Linux and OS X, or also for SunOS?