about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-05-03 18:12:35 -0400
committerJune McEnroe <june@causal.agency>2020-05-03 18:12:35 -0400
commit9ba9663454813c394c40a36cb085738876117c24 (patch)
tree5f59d361d3f8eff2adc041a981cae09c50c0f9db
parentRestrict extracted paths more tightly (diff)
downloadexman-9ba9663454813c394c40a36cb085738876117c24.tar.gz
exman-9ba9663454813c394c40a36cb085738876117c24.zip
Add README
-rw-r--r--README.746
1 files changed, 46 insertions, 0 deletions
diff --git a/README.7 b/README.7
new file mode 100644
index 0000000..0548095
--- /dev/null
+++ b/README.7
@@ -0,0 +1,46 @@
+.Dd May  3, 2020
+.Dt README 7
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm exman
+.Nd manuals for other systems
+.
+.Sh INSTALLING
+Use
+.Xr make 1
+to download and extract
+manuals for various systems:
+.Bd -literal -offset indent
+make
+.Ed
+.
+.Pp
+If
+.Xr tar 1
+is GNU,
+it requires the
+.Fl Fl wildcards
+option:
+.Bd -literal -offset indent
+TAR='tar --wildcards' make
+.Ed
+.
+.Pp
+Install manuals and the
+.Xr exman 1
+utility:
+.Bd -literal -offset indent
+sudo make install PREFIX=/usr/local
+.Ed
+.
+.Sh CONTRIBUTING
+The upstream URL of this project is
+.Aq Lk https://git.causal.agency/exman .
+Contributions in any form can be sent to
+.Aq Mt list+exman@causal.agency .
+For sending patches by email, see
+.Aq Lk https://git-send-email.io .
+.
+.Sh SEE ALSO
+.Xr exman 1
oe Installing mandoc from pkgsrc also installs a man executable which is horribly broken. Keep using the system man. 2019-02-20Set man_hard_wrap in nvimJune McEnroe Vendoring man.vim until <https://github.com/neovim/neovim/pull/9633> is merged and appears in a release. 2019-02-18Use hi -o anchor in upJune McEnroe 2019-02-18Don't match nested parentheses in Tag for CJune McEnroe Fixes mistaken highlight of: pngWrite(file, (uint8_t []) { 0, 0, 0 }, 3); 2019-02-18Match whitespace between * [] {}June McEnroe 2019-02-18Fix function-like #define regexJune McEnroe A define like #define FOO (1) is not function-like. 2019-02-18Match Tag in RustJune McEnroe 2019-02-18Match sh functions as TagJune McEnroe 2019-02-18Match Sh and Ss as Tag in mdocJune McEnroe 2019-02-18Match statics and typedefs as TagJune McEnroe 2019-02-18Clean up htmlHeaderJune McEnroe 2019-02-18Remove hi line numberingJune McEnroe Tags are much better for referring to specific parts of a file and line numbering is better done by a post-processing tool such as cat -n or producing a two-column HTML <table>. 2019-02-18Add Tag class to hiJune McEnroe 2019-02-17Generate HTML with hi -n -f html -o anchorJune McEnroe Running hi twice to insert stuff between the head and the content is a bit of a hack but oh well. 2019-02-17Add hi -f html -o anchor for line number linksJune McEnroe 2019-02-17Simplify temp trap in upJune McEnroe 2019-02-17Add line numbers to hiJune McEnroe Renames previous -n option to -m to stay consistent with cat -n. Prefixing lines with line numbers affects where the first tab indent ends up relative to the text above it. Not sure if it's worth fixing somehow. 2019-02-17Always split spans after newlinesJune McEnroe Simplifies ANSI and IRC output code, and prepares for line numbered output. 2019-02-15Color format specifiers light cyan in vimJune McEnroe 2019-02-15Highlight Interp as yellowJune McEnroe 2019-02-15Highlight strings in sh command substitutionsJune McEnroe 2019-02-15Add nmap gpJune McEnroe 2019-02-14Avoid newline when copying URL to pasteboardJune McEnroe 2019-02-13Add forgotten "sixth" book of H2G2June McEnroe