aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/tag.h
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2015-07-17 22:38:29 +0000
committerIngo Schwarze <schwarze@openbsd.org>2015-07-17 22:38:29 +0000
commit7221f76a236baf4056bfe1c909f3c978a4a94349 (patch)
treeeed560ed48c0b821fddc22bf6623153f70031431 /tag.h
parente1c3bf5030411d1b27f5509c2027238b63c1a49e (diff)
downloadmandoc-7221f76a236baf4056bfe1c909f3c978a4a94349.tar.gz
mandoc-7221f76a236baf4056bfe1c909f3c978a4a94349.tar.zst
mandoc-7221f76a236baf4056bfe1c909f3c978a4a94349.zip
Initial, still somewhat experimental implementation to leverage
less(1) -T and :t ctags(1)-like functionality to jump to the definitions of various terms inside manual pages. To be polished in the tree, so bear with me and report issues. Technically, if less(1) is used as a pager, information is collected by the mdoc(7) terminal formatter, first stored using the ohash library, then ultimately written to a temporary file which is passed to less via -T. No change intended for other output formatters or when running without a pager. Based on an idea from Kristaps using feedback from many, in particular phessler@ nicm@ millert@ halex@ doug@ kspillner@ deraadt@.
Diffstat (limited to 'tag.h')
-rw-r--r--tag.h27
1 files changed, 27 insertions, 0 deletions
diff --git a/tag.h b/tag.h
new file mode 100644
index 00000000..4456f323
--- /dev/null
+++ b/tag.h
@@ -0,0 +1,27 @@
+/* $Id: tag.h,v 1.1 2015/07/17 22:38:29 schwarze Exp $ */
+/*
+ * Copyright (c) 2015 Ingo Schwarze <schwarze@openbsd.org>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+__BEGIN_DECLS
+
+void tag_init(void);
+char *tag_filename(void);
+size_t tag_get(const char *, size_t);
+void tag_put(const char *, size_t, size_t);
+void tag_write(void);
+void tag_unlink(void);
+
+__END_DECLS