This repository has been archived by the owner on Nov 19, 2024. It is now read-only.
forked from rsdoiel/mkpage
-
Notifications
You must be signed in to change notification settings - Fork 1
/
sitemapper.1.html
100 lines (98 loc) · 2.52 KB
/
sitemapper.1.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<!DOCTYPE html>
<html>
<head>
<title>Caltech Library's Digital Library Development Sandbox</title>
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu"><img src="/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li>
<a href="/">Home</a>
</li>
<li>
<a href="index.html">README</a>
</li>
<li>
<a href="license.html">LICENSE</a>
</li>
<li>
<a href="install.html">INSTALL</a>
</li>
<li>
<a href="docs/">Documentation</a>
</li>
<li>
<a href="how-to/">HOW TO</a>
</li>
<li>
<a href="RELEASE-NOTES.html">Release Notes</a>
</li>
<li>
<a href="about.html">About</a>
</li>
<li>
<a href="https://github.com/caltechlibrary/mkpage">Github</a>
</li>
</ul>
</nav>
<section>
<p>
USAGE: sitemapper [OPTIONS] HTDOCS_PATH MAP_FILENAME PUBLIC_BASE_URL
</p>
<p>
DESCRIPTION
</p>
<p>
sitemapper generates a sitemap for the website.
</p>
<p>
ENVIRONMENT
</p>
<p>
Environment variables can be overridden by corresponding options
</p>
<pre><code>MKPAGE_DOCROOT set the document root, defaults to current working directory
MKPAGE_SITEMAP set the sitemap filename and path
MKPAGE_SITEURL set the site url</code></pre>
<p>
OPTIONS
</p>
<p>
Options will override any corresponding environment settings
</p>
<pre><code>-docs set the htdoc root
-examples display example(s)
-exclude A colon delimited list of path parts to exclude from sitemap
-generate-markdown generate markdown documentation
-h, -help display help
-l, -license display license
-o, -output output filename (for logging)
-quiet suppress error messages
-sitemap set the sitemap filename and path
-update, -update-frequency Set the change frequencely value, e.g. daily, weekly, monthly
-url set the site URL
-v, -version display version</code></pre>
<p>
EXAMPLES
</p>
<p>
sitemapper htdocs htdocs/sitemap.xml http://eprints.example.edu
</p>
<p>
sitemapper 1.0.4
</p>
</section>
<footer>
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span>
<span>© 2021 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<a class="cl-hide" href="sitemap.xml">Site Map</a>
</footer>
</body>
</html>