about summary refs log tree commit diff stats
path: root/doc/cha-mime.types.5
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2024-04-26 19:35:21 +0200
committerbptato <nincsnevem662@gmail.com>2024-04-26 19:45:53 +0200
commit601ad98818f3b966686181445339c52f74f75979 (patch)
tree3f245aacb085ccbee7e7b7c5efbf5b7cd318a5c1 /doc/cha-mime.types.5
parent83dae4a87a78190262317eca15cbb5d25989d41b (diff)
downloadchawan-601ad98818f3b966686181445339c52f74f75979.tar.gz
doc: include auto-generated manpages in repository
The 100kb or so doesn't hurt as much as not having manual pages at all
without pandoc (+ not auto-updating them through make all) does.
Diffstat (limited to 'doc/cha-mime.types.5')
-rw-r--r--doc/cha-mime.types.572
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/cha-mime.types.5 b/doc/cha-mime.types.5
new file mode 100644
index 00000000..c0f9aa14
--- /dev/null
+++ b/doc/cha-mime.types.5
@@ -0,0 +1,72 @@
+.\" Automatically generated by Pandoc 2.17.1.1
+.\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "cha-config" "5" "" "" "MIME type detection in Chawan"
+.hy
+.SH mime.types
+.PP
+Chawan uses the mime.types file to recognize certain file extensions for
+matching mailcap entries.
+See the \f[B]cha-mailcap\f[R](5) documentation for a description of
+mailcap.
+.SS Search path
+.PP
+Chawan parses all mime.types files defined in
+\f[V]external.mime-types\f[R].
+If no mime.types file was found, the built-in mime type associations are
+used.
+.PP
+The default search path for mime.types files is:
+.IP
+.nf
+\f[C]
+$HOME/.mime.types:/etc/mime.types:/usr/etc/mime.types:/usr/local/etc/mime.types
+\f[R]
+.fi
+.SS Format
+.PP
+The mime.types file is a list of whitespace-separated columns.
+The first column represents the mime type, all following columns are
+file extensions.
+.PP
+Lines starting with a hash character (#) are recognized as comments, and
+are ignored.
+.PP
+Example:
+.IP
+.nf
+\f[C]
+# comment
+application/x-example   exmpl   ex
+\f[R]
+.fi
+.PP
+This mime.types file would register the file extensions \[lq]exmpl\[rq]
+and \[lq]ex\[rq] to be recognized as the mime type
+\f[V]application/x-example\f[R].
+.SS Note
+.PP
+Chawan only uses mime.types files for finding mailcap entries; buffers
+use an internal mime.types file for content type detection instead.
+.PP
+The default mime.types file only includes file formats that buffers can
+handle, which is rather limited (at the time of writing, 7 file
+formats).
+Therefore it is highly recommended to configure at least one external
+mime.types file if you use mailcap.
+.SS See also
+.PP
+\f[B]cha\f[R](1)