code-srv-test/dita-ot-3.6/doc/topics/installing-via-homebrew.html
2021-03-23 22:38:58 +00:00

64 lines
No EOL
8.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2020"><meta name="generator" content="DITA-OT"><meta name="description" content="An alternative installation method can be used to install DITA-OT on macOS via Homebrew, the platforms most popular open-source package manager."><meta name="keywords" content="macOS, command, dita, Homebrew, installing"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Installing on macOS via Homebrew</title></head><body id="installing-via-homebrew"><header role="banner"><div class="header">
<p>DITA Open Toolkit</p>
<hr>
</div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.6</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a><ul><li><a href="../topics/prerequisite-software.html">Prerequisite software</a></li><li><a href="../topics/determining-version-of-ditaot.html">Checking the version</a></li><li><a href="../topics/first-build-using-dita-command.html">Building output</a></li><li class="active"><a href="../topics/installing-via-homebrew.html">Installing via Homebrew</a></li></ul></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">Parameters</a></li><li><a href="../topics/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
<h1 class="title topictitle1" id="ariaid-title1">Installing on macOS via Homebrew</h1>
<div class="body taskbody"><p class="shortdesc">An alternative installation method can be used to install DITA-OT on macOS via
<a class="xref" href="https://brew.sh" target="_blank" rel="external noopener">Homebrew</a>, the platforms most popular open-source package manager.</p>
<section class="section prereq"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Before you begin</h2></div>
<p class="p">The steps below assume you have already installed
<a class="xref" href="https://brew.sh" target="_blank" rel="external noopener">Homebrew</a> according to the instructions at
<a class="xref" href="https://brew.sh" target="_blank" rel="external noopener">brew.sh</a>.</p>
<div class="note tip note_tip"><span class="note__title">Tip:</span> Verify that your
<a class="xref" href="https://en.wikipedia.org/wiki/PATH_(variable)" target="_blank" rel="external noopener">PATH environment variable</a> begins with <span class="ph filepath">/usr/local/bin</span> to ensure that Homebrew-installed software
takes precedence over any programs of the same name elsewhere on the system.</div>
</section>
<section><div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Update Homebrew to make sure the latest package formulas are available on your system:</span>
<div class="itemgroup stepxmp"><pre class="pre codeblock syntax-bash"><code>$ <span class="keyword cmdname">brew update</span>
Already up-to-date.</code></pre></div>
<div class="itemgroup stepresult">
<p class="p">Homebrew responds with a list of any new or updated formulæ.</p></div>
</li><li class="li step stepexpand"><strong>Optional: </strong>
<span class="ph cmd">Check the version of DITA-OT that is available from Homebrew:</span>
<div class="itemgroup stepxmp"><pre class="pre codeblock syntax-bash"><code>$ <span class="keyword cmdname">brew info dita-ot</span>
<samp class="ph systemoutput sysout">dita-ot: stable <span class="keyword">3.6</span>
DITA Open Toolkit is an implementation of the OASIS DITA specification
https://www.dita-ot.org/
/usr/local/Cellar/dita-ot/<span class="keyword">3.6</span> (<var class="keyword varname">number of files</var>, <var class="keyword varname">package size</var>) *
Built from source on <var class="keyword varname">YYYY-MM-DD</var> at <var class="keyword varname">hh:mm:ss</var>
From: https://github.com/Homebrew/homebrew-core/blob/master/Formula/dita-ot.rb
==&gt; Requirements
Required: java &gt;= 1.8 ✔</samp>
</code></pre></div>
<div class="itemgroup stepresult">
<p class="p">The version of the DITA-OT formula is shown, along with basic information on the package.</p></div>
</li><li class="li step stepexpand">
<span class="ph cmd">Install the <code class="ph codeph">dita-ot</code> package:</span>
<div class="itemgroup stepxmp"><pre class="pre codeblock syntax-bash"><code>$ <span class="keyword cmdname">brew install dita-ot</span>
<samp class="ph systemoutput sysout">Downloading…</samp></code></pre></div>
<div class="itemgroup stepresult">
<p class="p">Homebrew will automatically download the latest version of the toolkit, install it in a subfolder of the
local package Cellar and symlink the <span class="keyword cmdname">dita</span> command to
<span class="ph filepath">/usr/local/bin/dita</span>.</p></div>
</li><li class="li step stepexpand"><strong>Optional: </strong>
<span class="ph cmd">Verify the installation:</span>
<div class="itemgroup stepxmp"><pre class="pre codeblock syntax-bash"><code>$ <span class="keyword cmdname">which dita</span>
<samp class="ph systemoutput sysout">/usr/local/bin/dita</samp></code></pre></div>
<div class="itemgroup stepresult">
<p class="p">The response confirms that the system will use the Homebrew-installed version of DITA-OT.</p></div>
</li><li class="li step stepexpand"><strong>Optional: </strong>
<span class="ph cmd">Check the DITA-OT version number:</span>
<div class="itemgroup stepxmp"><pre class="pre codeblock syntax-bash"><code>$ <span class="keyword cmdname">dita</span> <span class="keyword parmname">--version</span>
<samp class="ph systemoutput sysout">DITA-OT version <span class="keyword">3.6</span></samp></code></pre></div>
<div class="itemgroup stepresult">The DITA-OT version number appears on the console.</div>
</li></ol></section>
<section class="section result"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Results</h2></div>
<p class="p">You can now run the <span class="keyword cmdname">dita</span> command to transform DITA content.</p></section>
</div>
<nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../topics/installing-client.html" title="The DITA-OT distribution package can be installed on Linux, macOS, and Windows. It contains everything that you need to run the toolkit except for Java.">Installing DITA Open Toolkit</a></div></div><div class="linklist relinfo"><strong>Related information</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="https://www.oxygenxml.com/events/2018/dita-ot_day.html#installing_DITA-OT_on_macOS_via_homebrew" target="_blank" rel="external noopener" title="A new alternative installation method can now be used to install DITA-OT on macOS via the platform's most popular open-source package manager. This talk explains the benefits of this approach, highlights key differences to the default installation via .zip archive and demonstrates the new installation process.">Installing DITA-OT on macOS via Homebrew</a></li></ul></div></nav></article></main></body></html>