Skip to content

Commit d08c687

Browse files
authored
Merge pull request #42 from metacpan/mickey/docs
update docs
2 parents d828ca8 + ff99b3c commit d08c687

File tree

9 files changed

+20
-20
lines changed

9 files changed

+20
-20
lines changed

bin/backup.pl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ sub run_backup {
188188
189189
=head1 NAME
190190
191-
MetaCPAN::Script::Backup - Backup indices and types
191+
Backup indices and types
192192
193193
=head1 SYNOPSIS
194194

bin/checksum.pl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
9292
=head1 SYNOPSIS
9393
94-
# bin/metacpan checksum --[no-]dry_run --limit X
94+
# bin/checksum --[no-]dry_run --limit X
9595
9696
=head1 DESCRIPTION
9797

bin/cover.pl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ sub retrieve_cover_data {
8989
9090
=head1 SYNOPSIS
9191
92-
# bin/metacpan cover [--test] [json_file]
92+
# bin/cover [--test] [json_file]
9393
9494
=head1 DESCRIPTION
9595

bin/cpan_testers.pl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@
143143
144144
=head1 SYNOPSIS
145145
146-
$ bin/metacpan cpantesters
146+
$ bin/cpantesters
147147
148148
=head1 DESCRIPTION
149149

bin/cve.pl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ sub retrieve_cve_data {
212212
213213
=head1 SYNOPSIS
214214
215-
# bin/metacpan cve [--test] [json_file]
215+
# bin/cve [--test] [json_file]
216216
217217
=head1 DESCRIPTION
218218

bin/release.pl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -491,18 +491,18 @@ ()
491491
492492
=head1 SYNOPSIS
493493
494-
# bin/metacpan ~/cpan/authors/id/A
495-
# bin/metacpan ~/cpan/authors/id/A/AB/ABRAXXA/DBIx-Class-0.08127.tar.gz
496-
# bin/metacpan http://cpan.cpantesters.org/authors/id/D/DA/DAGOLDEN/CPAN-Meta-2.110580.tar.gz
494+
# bin/release ~/cpan/authors/id/A
495+
# bin/release ~/cpan/authors/id/A/AB/ABRAXXA/DBIx-Class-0.08127.tar.gz
496+
# bin/release http://cpan.cpantesters.org/authors/id/D/DA/DAGOLDEN/CPAN-Meta-2.110580.tar.gz
497497
498-
# bin/metacpan ~/cpan --age 24 --latest
498+
# bin/release ~/cpan --age 24 --latest
499499
500500
=head1 DESCRIPTION
501501
502502
This is the workhorse of MetaCPAN. It accepts a list of folders, files or urls
503503
and indexes the releases. Adding C<--latest> will set the status to C<latest>
504504
for the indexed releases If you are indexing more than one release, running
505-
L<MetaCPAN::Script::Latest> afterwards is probably faster.
505+
L<latest> afterwards is probably faster.
506506
507507
C<--age> sets the maximum age of the file in hours. Will be ignored when processing
508508
individual files or an url.

bin/river.pl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
4242
=head1 SYNOPSIS
4343
44-
# bin/metacpan river
44+
# bin/river
4545
4646
=head1 DESCRIPTION
4747

bin/snapshot.pl

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -216,30 +216,30 @@ ( $method, $path, $data )
216216
217217
=head1 NAME
218218
219-
MetaCPAN::Script::Snapshot - Snapshot (and restore) Elasticsearch indices
219+
Snapshot (and restore) Elasticsearch indices
220220
221221
=head1 SYNOPSIS
222222
223223
# Setup
224-
$ bin/metacpan snapshot --setup (only needed once)
224+
$ bin/snapshot --setup (only needed once)
225225
226226
# Snapshot all indexes daily
227-
$ bin/metacpan snapshot --snap --snap-stub full --date-format %Y-%m-%d
227+
$ bin/snapshot --snap --snap-stub full --date-format %Y-%m-%d
228228
229229
# List what has been snapshotted
230-
$ bin/metacpan snapshot --list
230+
$ bin/snapshot --list
231231
232232
# restore (indices are renamed from `foo` to `restored_foo`)
233-
$ bin/metacpan snapshot --restore --snap-name full_2016-12-01
233+
$ bin/snapshot --restore --snap-name full_2016-12-01
234234
235235
# purge anything older than 30 days and not created on the 1st of a month
236-
$ bin/metacpan snapshot --purge-old
236+
$ bin/snapshot --purge-old
237237
238238
Another example..
239239
240240
# Snapshot just user* indexes hourly and restore
241-
$ bin/metacpan snapshot --snap --indices 'user*' --snap-stub user --date-format '%Y-%m-%d-%H'
242-
$ bin/metacpan snapshot --restore --snap-name user_2016-12-01-12
241+
$ bin/snapshot --snap --indices 'user*' --snap-stub user --date-format '%Y-%m-%d-%H'
242+
$ bin/snapshot --restore --snap-name user_2016-12-01-12
243243
244244
Also useful:
245245

bin/watcher.pl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ ($release)
252252
253253
=head1 SYNOPSIS
254254
255-
# bin/metacpan watcher
255+
# bin/watcher
256256
257257
=head1 DESCRIPTION
258258

0 commit comments

Comments
 (0)