about summary refs log tree commit homepage
path: root/Documentation/olddoc.5.pod
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/olddoc.5.pod')
-rw-r--r--Documentation/olddoc.5.pod36
1 files changed, 36 insertions, 0 deletions
diff --git a/Documentation/olddoc.5.pod b/Documentation/olddoc.5.pod
new file mode 100644
index 0000000..bda770f
--- /dev/null
+++ b/Documentation/olddoc.5.pod
@@ -0,0 +1,36 @@
+=head1 NAME
+
+.olddoc.yml - olddoc config file format
+
+=head1 SYNOPSIS
+
+A YAML file in the top-level project directory named ".olddoc.yml"
+
+=head1 DESCRIPTION
+
+As olddoc favors consistency over configuration, there is minimal
+configuration to deal with.
+
+=head1 KEYS
+
+`rdoc_url`, `cgit_url`, and `nntp_url` should be obvious
+
+`merge_html` is a key-value mapping of (empty) RDoc source files to an
+HTML file that will be merged into RDoc after-the-fact.  It is useful
+for merging non-RDoc generated HTML into the project.
+
+`ml_url` is the mailing list archive location.
+`public_email` is the email address of a publically archived mailing list
+at `ml_url`
+
+As of olddoc 1.2.0, `ml_url` and `nntp_url` may be YAML arrays
+with multiple URLs.
+
+As of olddoc 1.3.0, the `source_code` array may be any number of
+commands or URLs.  This allows users of arbitrary version
+control systems to specify instructions for getting the code
+and not assume users are familiar with any particular system.
+
+=head1 SEE ALSO
+
+L<olddoc(1)>