Skip to content

Commit

Permalink
Update README by Pod::Markdown::Github
Browse files Browse the repository at this point in the history
  • Loading branch information
key-amb committed Mar 23, 2016
1 parent 76deade commit 06ce3c8
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 20 deletions.
36 changes: 21 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
[![Build Status](https://travis-ci.org/key-amb/perl5-App-Memcached-CLI.svg?branch=master)](https://travis-ci.org/key-amb/perl5-App-Memcached-CLI)
# NAME

__memcached-cli__ - Interactive CLI for Memcached
**memcached-cli** - Interactive CLI for Memcached

# SYNOPSIS

Run an interactive CLI:

memcached-cli <host[:port] | /path/to/socket> [options]
```
memcached-cli <host[:port] | /path/to/socket> [options]
# Without 1st arg, connects 127.0.0.1:11211 by default
memcached-cli [options]
# You can provide <addr> by option style
memcached-cli --addr|-a <host[:port] | /path/to/socket> [options]
# Without 1st arg, connects 127.0.0.1:11211 by default
memcached-cli [options]
# You can provide <addr> by option style
memcached-cli --addr|-a <host[:port] | /path/to/socket> [options]
```

These above turns into interactive mode like below:

memcached@SERVER:PORT>
memcached@SERVER:PORT> \h # show help
memcached@SERVER:PORT> \d # display slabs info
```
memcached@SERVER:PORT>
memcached@SERVER:PORT> \h # show help
memcached@SERVER:PORT> \d # display slabs info
```

Show Help/Manual:

memcached-cli -h|--help
memcached-cli --man
```
memcached-cli -h|--help
memcached-cli --man
```

# DESCRIPTION

Expand All @@ -34,18 +40,18 @@ command you run.

# OPTIONS

- __-t|--timeout=Int__
- **-t|--timeout=Int**

Sets connection timeout. Default is 5 seconds.
Sets connection timeout. Default is 1 seconds.

- __-d|--debug__
- **-d|--debug**

Shows debug logs.

# SEE ALSO

[App::Memcached::CLI](https://metacpan.org/pod/App::Memcached::CLI),
__memcached(1)__,
**memcached(1)**,
[http://www.memcached.org/](http://www.memcached.org/)

# AUTHORS
Expand Down
11 changes: 6 additions & 5 deletions minil.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
name = "App-Memcached-CLI"
badges = ["travis"]
authority="cpan:KEYAMB"
name = "App-Memcached-CLI"
badges = ["travis"]
authority = "cpan:KEYAMB"

module_maker="ModuleBuildTiny"
module_maker = "ModuleBuildTiny"

readme_from="script/memcached-cli"
readme_from = "script/memcached-cli"
markdown_maker = "Pod::Markdown::Github"

0 comments on commit 06ce3c8

Please sign in to comment.