Skip to content

Commit 49b51ad

Browse files
sunakusunaku
committed
Version 2.4.0 (2020-05-16)
1 parent 72e5525 commit 49b51ad

24 files changed

+83
-24
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
# Search API docs offline, in your terminal or browser
66

77
dasht is a collection of shell scripts for searching, browsing, and managing
8-
API documentation (in the form of [150+ offline documentation sets][docsets],
9-
courtesy of [Dash for OS X][Dash]) all from the comfort of your own terminal!
8+
API documentation (in the form of [210+ offline documentation sets][docsets],
9+
courtesy of [Dash for macOS][Dash]) all from the comfort of your own terminal!
1010

1111
The name "dasht" is a portmanteau of [Dash] and the letter "t", for terminal.
1212
Etymologically, "dasht" is Persian for _plain_, as in an flat expanse of land,

‎VERSION.md

+59
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,62 @@
1+
## Version 2.4.0 (2020-05-16)
2+
3+
This release drops special Web browser requirements to access dasht-server(1),
4+
improves error messages in dasht-docset-install(1), ensures clean up of stale
5+
files that contain whitespace in their names, and resolves a few other issues.
6+
7+
### Minor:
8+
9+
* dasht-server-http(1): serve local `file://` URLs through `http://` URLs.
10+
11+
Users no longer have to use special browsers or special configurations
12+
that allow the loading of `file://` links from `http://127.0.0.1` URLs.
13+
All browsers can now natively access the dasht-server(1) search engine.
14+
15+
See https://github.com/sunaku/dasht/issues/45
16+
17+
### Patch:
18+
19+
* dasht-docsets-update(1): remove stale files with whitespace in names.
20+
21+
Thanks to @frodeaa for reporting this issue and contributing a patch:
22+
23+
> Replace `xargs` with `while read` and avoid globbing. The same could be
24+
> achived by using `xargs -0` (GNU/BSD) if newline is replaced with `\0`.
25+
>
26+
> tr '\n' '\0' | xargs -0 sh -e -u -c '
27+
28+
See https://github.com/sunaku/dasht/issues/35
29+
30+
* dasht-server-http(1): escape "C++" docset name as `^C\+\+$` regex.
31+
32+
When the "C++" docset was selected from the "in docsets" dropdown menu in
33+
dasht-server(1), the plus signs weren't properly escaped per regex syntax.
34+
35+
See https://github.com/sunaku/dasht/issues/49
36+
37+
* dasht-docsets-install(1): validate gzip(1) integrity before extraction.
38+
39+
This avoids cryptic errors from tarball extraction:
40+
41+
gzip: stdin: unexpected end of file
42+
tar: Child returned status 1
43+
tar: Error is not recoverable: exiting now
44+
45+
By pointing out the cause of the error to the user:
46+
47+
gzip: Apple_Guides_and_Sample_Code.tgz: unexpected end of file
48+
49+
* dasht-docsets-install(1): restore support for older wget(1) versions.
50+
51+
Older wget versions don't support the `--show-progress` option:
52+
53+
wget: unrecognized option '--show-progress'
54+
Usage: wget [OPTION]... [URL]...
55+
56+
Try ‘wget --help’ for more options.
57+
58+
* dasht-query-line(1): update URI fragments for HTML and CSS docsets.
59+
160
## Version 2.3.0 (2018-10-09)
261

362
This release provides better error messaging for first-time users who try to

‎bin/dasht

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT 1 2018-10-09 2.3.0
3+
# # DASHT 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-docsets

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-DOCSETS 1 2018-10-09 2.3.0
3+
# # DASHT-DOCSETS 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-docsets-extract

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-DOCSETS-EXTRACT 1 2018-10-09 2.3.0
3+
# # DASHT-DOCSETS-EXTRACT 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-docsets-install

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-DOCSETS-INSTALL 1 2018-10-09 2.3.0
3+
# # DASHT-DOCSETS-INSTALL 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-docsets-remove

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-DOCSETS-REMOVE 1 2018-10-09 2.3.0
3+
# # DASHT-DOCSETS-REMOVE 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-docsets-update

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-DOCSETS-UPDATE 1 2018-10-09 2.3.0
3+
# # DASHT-DOCSETS-UPDATE 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-query-exec

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-QUERY-EXEC 1 2018-10-09 2.3.0
3+
# # DASHT-QUERY-EXEC 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-query-html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-QUERY-HTML 1 2018-10-09 2.3.0
3+
# # DASHT-QUERY-HTML 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-query-line

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-QUERY-LINE 1 2018-10-09 2.3.0
3+
# # DASHT-QUERY-LINE 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-server

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-SERVER 1 2018-10-09 2.3.0
3+
# # DASHT-SERVER 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎bin/dasht-server-http

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/sh -e
22
#
3-
# # DASHT-SERVER-HTTP 1 2018-10-09 2.3.0
3+
# # DASHT-SERVER-HTTP 1 2020-05-16 2.4.0
44
#
55
# ## NAME
66
#

‎man/man1/dasht-docsets-extract.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-DOCSETS\-EXTRACT 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-DOCSETS\-EXTRACT 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-docsets\-extract \- extracts Dash \[la]https://kapeli.com/dash\[ra] docset archives (\fB\fC*.tgz\fR files)

‎man/man1/dasht-docsets-install.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-DOCSETS\-INSTALL 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-DOCSETS\-INSTALL 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-docsets\-install \- installs new Dash \[la]https://kapeli.com/dash\[ra] docsets

‎man/man1/dasht-docsets-remove.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-DOCSETS\-REMOVE 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-DOCSETS\-REMOVE 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-docsets\-remove \- removes installed Dash \[la]https://kapeli.com/dash\[ra] docsets

‎man/man1/dasht-docsets-update.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-DOCSETS\-UPDATE 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-DOCSETS\-UPDATE 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-docsets\-update \- updates installed Dash \[la]https://kapeli.com/dash\[ra] docsets

‎man/man1/dasht-docsets.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-DOCSETS 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-DOCSETS 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-docsets \- lists installed Dash \[la]https://kapeli.com/dash\[ra] docsets

‎man/man1/dasht-query-exec.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-QUERY\-EXEC 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-QUERY\-EXEC 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-query\-exec \- searches a Dash \[la]https://kapeli.com/dash\[ra] docset's SQLite3 database file

‎man/man1/dasht-query-html.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-QUERY\-HTML 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-QUERY\-HTML 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-query\-html \- searches Dash \[la]https://kapeli.com/dash\[ra] docsets and emits HTML table rows

‎man/man1/dasht-query-line.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-QUERY\-LINE 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-QUERY\-LINE 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-query\-line \- searches Dash \[la]https://kapeli.com/dash\[ra] docsets and emits groups of lines

‎man/man1/dasht-server-http.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-SERVER\-HTTP 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-SERVER\-HTTP 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-server\-http \- simple search engine that powers

‎man/man1/dasht-server.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT\-SERVER 1 2018\-10\-09 2.3.0
1+
.TH DASHT\-SERVER 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht\-server \- runs a local search engine for your web browser

‎man/man1/dasht.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH DASHT 1 2018\-10\-09 2.3.0
1+
.TH DASHT 1 2018\-10\-09 2.4.0
22
.SH NAME
33
.PP
44
dasht \- API documentation in your terminal

0 commit comments

Comments
 (0)