Quick Save

rsdoiel · Jun 20, 2023 · aa27ad3 · aa27ad3
1 parent 05f5925
commit aa27ad3
Show file tree

Hide file tree

Showing 9 changed files with 262 additions and 37 deletions.
diff --git a/INSTALL.html b/INSTALL.html
@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <meta name="language" content="EN">
+  <title>R. S. Doiel, Software Engineer/Analyst - INSTALL</title>
+
+  <link rel="stylesheet" type="text/css"  href="/printfonts/print.css" media="print" />
+  <link rel="stylesheet" type="text/css"  href="/webfonts/fonts.css" media="screen" />
+  <link rel="stylesheet" type="text/css"  href="/css/site.css" media="screen" />
+  <link title="RSS feed for rsdoiel's blog" rel="alternate" type="application/rss+xml" href="https://rsdoiel.github.io/rss.xml" />
+  <link title="markdown source for page" rel="alternative" type="application/markdown" href="INSTALL.md">
+</head>
+<body>
+<nav>
+<ul>
+<li><a href="/">Home</a></li>
+<li><a href="./">README</a></li>
+<li><a href="user-manual.html">User Manual</a></li>
+<li><a href="license.html">LICENSE</a></li>
+<li><a href="about.html">About</a></li>
+<li><a href="https://github.com/rsdoiel/osf">GitHub</a></li>
+</ul>
+</nav>
+
+<section>
+<!--  <h1>INSTALL</h1> -->
+
+<h2 id="installation">Installation</h2>
+<p>This project is experimental. Get the latest release from <a href="https://github.com/rsdoiel/osf/releases/">GitHub</a>.</p>
+<h2 id="quick-install-with-curl">Quick install with curl</h2>
+<p>If you are using macOS or Linux you maybe able to install osf using the following curl command.</p>
+<pre class="shell"><code>curl https://rsdoiel.github.io/osf/installer.sh | sh</code></pre>
+<h2 id="install-from-source">Install from source</h2>
+<h2 id="requirements">Requirements</h2>
+<ul>
+<li>Golang &gt;= 1.20</li>
+<li>Pandoc &gt;= 3</li>
+<li>GNU Make</li>
+<li>Git</li>
+</ul>
+<h2 id="steps">Steps</h2>
+<ol type="1">
+<li>Clone the Git repository for the project</li>
+<li>change directory into the cloned project</li>
+<li>Run <code>make</code>, <code>make test</code> and <code>make install</code></li>
+</ol>
+<p>Here’s what that looks like for me.</p>
+<pre><code>git clone https://github.com/rsdoiel/osf src/github.com/rsdoiel/osf
+cd src/github.com/rsdoiel/osf
+make
+make test
+make install</code></pre>
+<p>By default it will install the programs in <code>$HOME/bin</code>. <code>$HOME/bin</code> needs to be included in your <code>PATH</code>. E.g.</p>
+<pre><code>export PATH=&quot;$HOME/bin:$PATH&quot;</code></pre>
+<p>Can be added to your <code>.profile</code>, <code>.bashrc</code> or <code>.zshrc</code> file depending on your system’s shell.</p>
+</section>
+
+<footer>
+</footer>
+
+</body>
+</html>
diff --git a/fadein2osf.1.html b/fadein2osf.1.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <meta name="language" content="EN">
+  <title>R. S. Doiel, Software Engineer/Analyst - fadein2osf.1</title>
+
+  <link rel="stylesheet" type="text/css"  href="/printfonts/print.css" media="print" />
+  <link rel="stylesheet" type="text/css"  href="/webfonts/fonts.css" media="screen" />
+  <link rel="stylesheet" type="text/css"  href="/css/site.css" media="screen" />
+  <link title="RSS feed for rsdoiel's blog" rel="alternate" type="application/rss+xml" href="https://rsdoiel.github.io/rss.xml" />
+  <link title="markdown source for page" rel="alternative" type="application/markdown" href="fadein2osf.1.md">
+</head>
+<body>
+<nav>
+<ul>
+<li><a href="/">Home</a></li>
+<li><a href="./">README</a></li>
+<li><a href="user-manual.html">User Manual</a></li>
+<li><a href="license.html">LICENSE</a></li>
+<li><a href="about.html">About</a></li>
+<li><a href="https://github.com/rsdoiel/osf">GitHub</a></li>
+</ul>
+</nav>
+
+<section>
+<!--  <h1>fadein2osf.1</h1> -->
+
+<p>USAGE: fadein2osf [OPTIONS]</p>
+<p>DESCRIPTION</p>
+<p>fadein2osf is a command line program that reads an “.fadein” file and write outs a OSF 2.0 XML.</p>
+<p>OPTIONS</p>
+<pre><code>-generate-manpage    generate man page
+-generate-markdown   generate Markdown documentation
+-h, -help            display help
+-i, -input           set the input filename
+-l, -license         display license
+-nl, -newline        add a trailing newline
+-o, -output          set the output filename
+-quiet               suppress error messages
+-v, -version         display version</code></pre>
+<p>EXAMPLES</p>
+<p>Convert <em>screenplay.fadein</em> into <em>screenplay.osf</em>.</p>
+<pre><code>fadein2osf -i screenplay.fadein -o screenplay.osf</code></pre>
+<p>Display converted OSF 2.0 XML to the console</p>
+<pre><code>fadein2osf -i screenplay.fadein</code></pre>
+<p>fadein2osf 0.0.4</p>
+</section>
+
+<footer>
+</footer>
+
+</body>
+</html>
diff --git a/fadein2osf.1.md b/fadein2osf.1.md
@@ -8,15 +8,15 @@ and write outs a OSF 2.0 XML.
 
 OPTIONS
 
-    -generate-manpage   generate man page
-    -generate-markdown  generate Markdown documentation
-    -h, -help           display help
-    -i, -input          set the input filename
-    -l, -license        display license
-    -nl, -newline       add a trailing newline
-    -o, -output         set the output filename
-    -quiet              suppress error messages
-    -v, -version        display version
+    -generate-manpage    generate man page
+    -generate-markdown   generate Markdown documentation
+    -h, -help            display help
+    -i, -input           set the input filename
+    -l, -license         display license
+    -nl, -newline        add a trailing newline
+    -o, -output          set the output filename
+    -quiet               suppress error messages
+    -v, -version         display version
 
 
 EXAMPLES

diff --git a/man/man1/fadein2osf.1 b/man/man1/fadein2osf.1
@@ -14,15 +14,15 @@ OPTIONS
 .IP
 .nf
 \f[C]
--generate-manpage   generate man page
--generate-markdown  generate Markdown documentation
--h, -help           display help
--i, -input          set the input filename
--l, -license        display license
--nl, -newline       add a trailing newline
--o, -output         set the output filename
--quiet              suppress error messages
--v, -version        display version
+-generate-manpage    generate man page
+-generate-markdown   generate Markdown documentation
+-h, -help            display help
+-i, -input           set the input filename
+-l, -license         display license
+-nl, -newline        add a trailing newline
+-o, -output          set the output filename
+-quiet               suppress error messages
+-v, -version         display version
 \f[R]
 .fi
 .PP

diff --git a/man/man1/osf2txt.1 b/man/man1/osf2txt.1
@@ -14,15 +14,15 @@ OPTIONS
 .IP
 .nf
 \f[C]
--generate-manpage   generate man page
--generate-markdown  generate Markdown documentation
--h, -help           display help
--i, -input          set the input filename
--l, -license        display license
--nl, -newline       add a trailing newline
--o, -output         set the output filename
--quiet              suppress error messages
--v, -version        display version
+-generate-manpage    generate man page
+-generate-markdown   generate Markdown documentation
+-h, -help            display help
+-i, -input           set the input filename
+-l, -license         display license
+-nl, -newline        add a trailing newline
+-o, -output          set the output filename
+-quiet               suppress error messages
+-v, -version         display version
 \f[R]
 .fi
 .PP

diff --git a/osf2txt.1.html b/osf2txt.1.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <meta name="language" content="EN">
+  <title>R. S. Doiel, Software Engineer/Analyst - osf2txt.1</title>
+
+  <link rel="stylesheet" type="text/css"  href="/printfonts/print.css" media="print" />
+  <link rel="stylesheet" type="text/css"  href="/webfonts/fonts.css" media="screen" />
+  <link rel="stylesheet" type="text/css"  href="/css/site.css" media="screen" />
+  <link title="RSS feed for rsdoiel's blog" rel="alternate" type="application/rss+xml" href="https://rsdoiel.github.io/rss.xml" />
+  <link title="markdown source for page" rel="alternative" type="application/markdown" href="osf2txt.1.md">
+</head>
+<body>
+<nav>
+<ul>
+<li><a href="/">Home</a></li>
+<li><a href="./">README</a></li>
+<li><a href="user-manual.html">User Manual</a></li>
+<li><a href="license.html">LICENSE</a></li>
+<li><a href="about.html">About</a></li>
+<li><a href="https://github.com/rsdoiel/osf">GitHub</a></li>
+</ul>
+</nav>
+
+<section>
+<!--  <h1>osf2txt.1</h1> -->
+
+<p>USAGE: osf2txt [OPTIONS]</p>
+<p>DESCRIPTION</p>
+<p>osf2txt is a command line program that reads an osf file and returns plain text</p>
+<p>OPTIONS</p>
+<pre><code>-generate-manpage    generate man page
+-generate-markdown   generate Markdown documentation
+-h, -help            display help
+-i, -input           set the input filename
+-l, -license         display license
+-nl, -newline        add a trailing newline
+-o, -output          set the output filename
+-quiet               suppress error messages
+-v, -version         display version</code></pre>
+<p>EXAMPLES</p>
+<p>Convert <em>screenplay.osf</em> into <em>screenplay.txt</em>.</p>
+<pre><code>osf2txt -i screenplay.osf -o screenplay.txt</code></pre>
+<p>Or alternatively</p>
+<pre><code>cat screenplay.osf | osf2txt &gt; screenplay.txt</code></pre>
+<p>osf2txt 0.0.4</p>
+</section>
+
+<footer>
+</footer>
+
+</body>
+</html>
diff --git a/osf2txt.1.md b/osf2txt.1.md
@@ -8,15 +8,15 @@ and returns plain text
 
 OPTIONS
 
-    -generate-manpage   generate man page
-    -generate-markdown  generate Markdown documentation
-    -h, -help           display help
-    -i, -input          set the input filename
-    -l, -license        display license
-    -nl, -newline       add a trailing newline
-    -o, -output         set the output filename
-    -quiet              suppress error messages
-    -v, -version        display version
+    -generate-manpage    generate man page
+    -generate-markdown   generate Markdown documentation
+    -h, -help            display help
+    -i, -input           set the input filename
+    -l, -license         display license
+    -nl, -newline        add a trailing newline
+    -o, -output          set the output filename
+    -quiet               suppress error messages
+    -v, -version         display version
 
 
 EXAMPLES

diff --git a/txt2osf.1.html b/txt2osf.1.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <meta name="language" content="EN">
+  <title>R. S. Doiel, Software Engineer/Analyst - txt2osf.1</title>
+
+  <link rel="stylesheet" type="text/css"  href="/printfonts/print.css" media="print" />
+  <link rel="stylesheet" type="text/css"  href="/webfonts/fonts.css" media="screen" />
+  <link rel="stylesheet" type="text/css"  href="/css/site.css" media="screen" />
+  <link title="RSS feed for rsdoiel's blog" rel="alternate" type="application/rss+xml" href="https://rsdoiel.github.io/rss.xml" />
+  <link title="markdown source for page" rel="alternative" type="application/markdown" href="txt2osf.1.md">
+</head>
+<body>
+<nav>
+<ul>
+<li><a href="/">Home</a></li>
+<li><a href="./">README</a></li>
+<li><a href="user-manual.html">User Manual</a></li>
+<li><a href="license.html">LICENSE</a></li>
+<li><a href="about.html">About</a></li>
+<li><a href="https://github.com/rsdoiel/osf">GitHub</a></li>
+</ul>
+</nav>
+
+<section>
+<!--  <h1>txt2osf.1</h1> -->
+
+<p>USAGE: txt2osf [OPTIONS]</p>
+<p>DESCRIPTION</p>
+<p>txt2osf is a command line program that reads an plain text file and returns an OSF 2.0 text</p>
+<p>OPTIONS</p>
+<pre><code>-generate-manpage    generate man page
+-generate-markdown   generate Markdown documentation
+-h, -help            display help
+-i, -input           set the input filename
+-l, -license         display license
+-nl, -newline        add a trailing newline
+-o, -output          set the output filename
+-quiet               suppress error messages
+-v, -version         display version</code></pre>
+<p>EXAMPLES</p>
+<p>Convert <em>screenplay.txt</em> into <em>screenplay.osf</em>.</p>
+<pre><code>txt2osf -i screenplay.txt -o screenplay.osf</code></pre>
+<p>Or alternatively</p>
+<pre><code>cat screenplay.txt | txt2osf &gt; screenplay.osf</code></pre>
+<p>txt2osf 0.0.4</p>
+</section>
+
+<footer>
+</footer>
+
+</body>
+</html>
diff --git a/version.go b/version.go
@@ -12,7 +12,7 @@ const (
     ReleaseDate = "2023-06-20"
 
     // ReleaseHash, the Git hash when version.go was generated
-    ReleaseHash = "ef45b73"
+    ReleaseHash = "05f5925"
 
     LicenseText = `
 All rights reserved.