garethellis / tldr-php
A PHP client for the TLDR man pages project
dev-master / 1.0.x-dev
2016-07-27 20:33 UTC
Requires
- php: ^7.0
- guzzlehttp/guzzle: ^6.1
- symfony/console: ^3.0
- tedivm/stash: ^0.13.2
Requires (Dev)
- phpunit/phpunit: ^4.0|^5.1
- scrutinizer/ocular: ~1.3
- squizlabs/php_codesniffer: ~2.5
This package is auto-updated.
Last update: 2024-03-29 03:01:27 UTC
README
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.