aboutsummaryrefslogtreecommitdiffstats
path: root/extra
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@archive.org>2021-08-10 16:43:35 -0700
committerBryan Newbold <bnewbold@archive.org>2021-08-10 16:43:51 -0700
commit8e73859337001ad94a944ba6a287abc64b9d3497 (patch)
tree533d511636408a96d8583ab67a30ace267953d7e /extra
parent9727f9f9d1c18db867ddf11617be7e7601773dbb (diff)
downloadfatcat-cli-8e73859337001ad94a944ba6a287abc64b9d3497.tar.gz
fatcat-cli-8e73859337001ad94a944ba6a287abc64b9d3497.zip
update manpage for refs, fulltext search
Diffstat (limited to 'extra')
-rw-r--r--extra/fatcat-cli.16
-rw-r--r--extra/fatcat-cli.1.scdoc2
2 files changed, 3 insertions, 5 deletions
diff --git a/extra/fatcat-cli.1 b/extra/fatcat-cli.1
index ddf0ef6..d81f5f8 100644
--- a/extra/fatcat-cli.1
+++ b/extra/fatcat-cli.1
@@ -4,7 +4,7 @@
.nh
.ad l
.\" Begin generated content:
-.TH "fatcat-cli" "1" "2021-02-15" "Fatcat API Tool Manual Page"
+.TH "fatcat-cli" "1" "2021-08-10" "Fatcat API Tool Manual Page"
.P
.SH NAME
.P
@@ -16,8 +16,6 @@ fatcat-cli [OPTIONS] <COMMAND> <ARGS>
.P
.SH DESCRIPTION
.P
-NOTE: this manual page is a work-in-progress
-.P
This is simple command-line interface to the fatcat catalog API. Fatcat (https://fatcat.wiki) is an open bibliographic catalog of scholarly works, with a focus on access and preservation.
.P
Many commands will work out-of-the-box, but all editing actions require authentication. Create an account on https://fatcat.wiki, then generate an API token (a long string of random characters) from the account page, and export to your shell environment (read below for the env variable to use).
@@ -29,7 +27,7 @@ Many commands will work out-of-the-box, but all editing actions require authenti
.RS 4
\fBsearch\fR <ENTITY-TYPE> <QUERY>...
.RS 4
-Query the search index for entities of a specified type. Currently `release`, `container`, and `file` indexes are searchable. By default prints a table with a subset of metadata, but `--index-json` will output the search engine JSON document, or `--entity-json` will do an API fetch for each result and print the full entity JSON.
+Query the search index for entities of a specified type. Currently `release`, `container`, `fulltext`, `refs`, and `file` indexes are searchable. By default prints a table with a subset of metadata, but `--index-json` will output the search engine JSON document, or `--entity-json` will do an API fetch for each result and print the full entity JSON.
.P
.RE
.RE
diff --git a/extra/fatcat-cli.1.scdoc b/extra/fatcat-cli.1.scdoc
index a3dedb5..cee68ab 100644
--- a/extra/fatcat-cli.1.scdoc
+++ b/extra/fatcat-cli.1.scdoc
@@ -19,7 +19,7 @@ Many commands will work out-of-the-box, but all editing actions require authenti
## Search Commands
*search* <ENTITY-TYPE> <QUERY>...
- Query the search index for entities of a specified type. Currently `release`, `container`, and `file` indexes are searchable. By default prints a table with a subset of metadata, but `--index-json` will output the search engine JSON document, or `--entity-json` will do an API fetch for each result and print the full entity JSON.
+ Query the search index for entities of a specified type. Currently `release`, `container`, `fulltext`, `refs`, and `file` indexes are searchable. By default prints a table with a subset of metadata, but `--index-json` will output the search engine JSON document, or `--entity-json` will do an API fetch for each result and print the full entity JSON.
## Single Entity Commands