garethellis/tldr-php

A PHP client for the TLDR man pages project

dev-master / 1.0.x-dev 2016-07-27 20:33 UTC

This package is auto-updated.

Last update: 2020-07-30 00:57:33 UTC


README

Build Status Scrutinizer Code Quality Code Coverage Code Climate

This is a PHP client for the TLDR man pages project.

Requirements

  • Internet connectivity (pages will be cached for faster retrieval and offline usage)
  • PHP >= 7

Usage

This client is still in development. At this time, to use the client, you should clone this repo and run the following:

bin/tldr <command>

Options

tldr <command> --os=osx Filter for man pages relating to the given operating system. Without this option set, the application will attempt to determine your OS and use that. Valid operating system values are osx, linux and sunos.

tldr <command> --refresh-cache Forces the application to reload the given man page from the remote source and refreshes the local cache.

tldr --flush-cache Delete all man pages from the local cache.

More

Contributing
License