Merge pull request #42 from metacpan/mickey/docs

update docs
metacpan · Sep 30, 2024 · d08c687 · d08c687
2 parents d828ca8 + ff99b3c
commit d08c687
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 20 deletions.
diff --git a/bin/backup.pl b/bin/backup.pl
@@ -188,7 +188,7 @@ sub run_backup {
 
 =head1 NAME
 
-MetaCPAN::Script::Backup - Backup indices and types
+Backup indices and types
 
 =head1 SYNOPSIS
 

diff --git a/bin/checksum.pl b/bin/checksum.pl
@@ -91,7 +91,7 @@
 
 =head1 SYNOPSIS
 
- # bin/metacpan checksum --[no-]dry_run --limit X
+ # bin/checksum --[no-]dry_run --limit X
 
 =head1 DESCRIPTION
 

diff --git a/bin/cover.pl b/bin/cover.pl
@@ -89,7 +89,7 @@ sub retrieve_cover_data {
 
 =head1 SYNOPSIS
 
- # bin/metacpan cover [--test] [json_file]
+ # bin/cover [--test] [json_file]
 
 =head1 DESCRIPTION
 

diff --git a/bin/cpan_testers.pl b/bin/cpan_testers.pl
@@ -143,7 +143,7 @@
 
 =head1 SYNOPSIS
 
- $ bin/metacpan cpantesters
+ $ bin/cpantesters
 
 =head1 DESCRIPTION
 

diff --git a/bin/cve.pl b/bin/cve.pl
@@ -212,7 +212,7 @@ sub retrieve_cve_data {
 
 =head1 SYNOPSIS
 
- # bin/metacpan cve [--test] [json_file]
+ # bin/cve [--test] [json_file]
 
 =head1 DESCRIPTION
 

diff --git a/bin/release.pl b/bin/release.pl
@@ -491,18 +491,18 @@ ()
 
 =head1 SYNOPSIS
 
- # bin/metacpan ~/cpan/authors/id/A
- # bin/metacpan ~/cpan/authors/id/A/AB/ABRAXXA/DBIx-Class-0.08127.tar.gz
- # bin/metacpan http://cpan.cpantesters.org/authors/id/D/DA/DAGOLDEN/CPAN-Meta-2.110580.tar.gz
+ # bin/release ~/cpan/authors/id/A
+ # bin/release ~/cpan/authors/id/A/AB/ABRAXXA/DBIx-Class-0.08127.tar.gz
+ # bin/release http://cpan.cpantesters.org/authors/id/D/DA/DAGOLDEN/CPAN-Meta-2.110580.tar.gz
 
- # bin/metacpan ~/cpan --age 24 --latest
+ # bin/release ~/cpan --age 24 --latest
 
 =head1 DESCRIPTION
 
 This is the workhorse of MetaCPAN. It accepts a list of folders, files or urls
 and indexes the releases. Adding C<--latest> will set the status to C<latest>
 for the indexed releases If you are indexing more than one release, running
-L<MetaCPAN::Script::Latest> afterwards is probably faster.
+L<latest> afterwards is probably faster.
 
 C<--age> sets the maximum age of the file in hours. Will be ignored when processing
 individual files or an url.

diff --git a/bin/river.pl b/bin/river.pl
@@ -41,7 +41,7 @@
 
 =head1 SYNOPSIS
 
- # bin/metacpan river
+ # bin/river
 
 =head1 DESCRIPTION
 

diff --git a/bin/snapshot.pl b/bin/snapshot.pl
@@ -216,30 +216,30 @@ ( $method, $path, $data )
 
 =head1 NAME
 
-MetaCPAN::Script::Snapshot - Snapshot (and restore) Elasticsearch indices
+Snapshot (and restore) Elasticsearch indices
 
 =head1 SYNOPSIS
 
 # Setup
- $ bin/metacpan snapshot --setup (only needed once)
+ $ bin/snapshot --setup (only needed once)
 
 # Snapshot all indexes daily
- $ bin/metacpan snapshot --snap --snap-stub full --date-format %Y-%m-%d
+ $ bin/snapshot --snap --snap-stub full --date-format %Y-%m-%d
 
 # List what has been snapshotted
- $ bin/metacpan snapshot --list
+ $ bin/snapshot --list
 
 # restore (indices are renamed from `foo` to `restored_foo`)
- $ bin/metacpan snapshot --restore --snap-name full_2016-12-01
+ $ bin/snapshot --restore --snap-name full_2016-12-01
 
 # purge anything older than 30 days and not created on the 1st of a month
- $ bin/metacpan snapshot --purge-old
+ $ bin/snapshot --purge-old
 
 Another example..
 
 # Snapshot just user* indexes hourly and restore
- $ bin/metacpan snapshot --snap --indices 'user*' --snap-stub user --date-format '%Y-%m-%d-%H'
- $ bin/metacpan snapshot --restore --snap-name user_2016-12-01-12
+ $ bin/snapshot --snap --indices 'user*' --snap-stub user --date-format '%Y-%m-%d-%H'
+ $ bin/snapshot --restore --snap-name user_2016-12-01-12
 
 Also useful:
 

diff --git a/bin/watcher.pl b/bin/watcher.pl
@@ -252,7 +252,7 @@ ($release)
 
 =head1 SYNOPSIS
 
- # bin/metacpan watcher
+ # bin/watcher
 
 =head1 DESCRIPTION