Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

See also #81

Merged
merged 4 commits into from
Feb 24, 2016
Merged

See also #81

merged 4 commits into from
Feb 24, 2016

Conversation

igorshubovych
Copy link
Collaborator

It parses all other commands in backticks. If they are in the index, then it renders them additionally in "See Also" section in the end.

Note: this is not real command description

# uname
> Print details about the current machine and the operating system running on it.
> Note: If you're on Linux, try also the `lsb_release` command.

- Print hardware-related information: machine and processor (see `ln`):

`uname -mp`

- Print operating system, release number, and version (see `lsb_release`):

`uname -srv`

- Print all available system information (hardware, software, nodename), see `ls`:

`uname -a`

It will give the following output. Take a look on See Also section at the end.

$ tldr uname

  uname
  Print details about the current machine and the operating system running on it.
  Note: If you're on Linux, try also the lsb_release command.

  - Print hardware-related information: machine and processor (see ln):
    uname -mp

  - Print operating system, release number, and version (see lsb_release):
    uname -srv

  - Print all available system information (hardware, software, nodename), see ls:
    uname -a


See also:
  - lsb_release
  - ln
  - ls

@notpeter
Copy link
Contributor

I really like this idea, but would prefer it rendered on a single line (comma separated?) rather than as a bulleted list. So something like:

See also: lsb_release, ln, ls

@agnivade
Copy link
Member

I just checked with the node client. It doesn't seem to show any 'see also' section.

$tldr uname

  uname
  Print details about the current machine and the operating system running on it.
  Note: If you're on Linux, try also the lsb_release command.

  - Print hardware-related information: machine and processor:
    uname -mp

  - Print software-related information: operating system, release number, and version:
    uname -srv

  - Print the nodename (hostname) of the system:
    uname -n

  - Print all available system information (hardware, software, nodename):
    uname -a

Am I missing anything ? Or is this a regression ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants