Package org.forgerock.doc.maven.post

Class ManpagePost

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.forgerock.doc.maven.AbstractDocbkxMojo

org.forgerock.doc.maven.post.ManpagePost

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class ManpagePost
extends AbstractDocbkxMojo

Fix man page file locations.

Nested Class Summary

Nested classes/interfaces inherited from class org.forgerock.doc.maven.AbstractDocbkxMojo

AbstractDocbkxMojo.Format, AbstractDocbkxMojo.ProfileAttributes

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ManpagePost(AbstractDocbkxMojo mojo)	Constructor setting the Mojo that holds the configuration.

Method Summary

Modifier and Type	Method	Description
void	execute()	Fix man page file locations.

Methods inherited from class org.forgerock.doc.maven.AbstractDocbkxMojo

areSectionsAutolabeled, doBuildReleaseZip, doCopyResourceFiles, doCreateArtifacts, doesSectionLabelIncludeComponentLabel, doOverwriteModifiableCopy, doOverwriteProjectFilesWithSharedContent, doUsePreProcessedSources, getArtifactItems, getAsciidocSourceDirectory, getAsciidoctorPluginVersion, getBackstageDirectory, getBackstageProductName, getBaseConfiguration, getBaseDir, getBootstrapCustomization, getBrandingArtifactId, getBrandingGroupId, getBrandingVersion, getBuildDirectory, getChunkedHTMLCustomization, getCommonContentArtifactId, getCommonContentGroupId, getCommonContentVersion, getDocbkxModifiableSourcesDirectory, getDocbkxOutputDirectory, getDocbkxSourceDirectory, getDocbkxVersion, getDocNames, getDocsSite, getDocumentSrcName, getDraftWatermarkURL, getEoslJson, getEpubCustomization, getExclusions, getFaviconLink, getFoCustomization, getFontsDirectory, getFopHyphVersion, getFopLogLevel, getFormats, getGoogleAnalyticsId, getInclusions, getJavaScriptFileName, getJCiteSourcePaths, getJCiteVersion, getLatestJson, getLinkTesterVersion, getLocaleTag, getManpagesCustomization, getMavenAssemblyVersion, getMavenDependencyVersion, getMavenFilteringVersion, getMavenResourcesVersion, getMaxImageHeightInInches, getPlantUmlVersion, getPlexusUtilsVersion, getPluginManager, getPreSiteCss, getProject, getProjectName, getProjectVersion, getRelativeResourcesDirectoryPath, getReleaseCss, getReleaseDate, getReleaseDirectory, getReleaseFaviconLink, getReleaseVersion, getReleaseVersionPath, getResourcesDirectory, getSession, getSingleHTMLCustomization, getSiteDirectory, getSkipUrlPatterns, getWebHelpCss, getWebHelpCustomization, getWebHelpLogo, getXCiteVersion, getXhtml5Customization, isDraftMode, isXincludeSupported, keepCustomIndexHtml, path, runLinkTester, skipLinkCheck, useAnsi, useSyntaxHighlighting

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ManpagePost

public ManpagePost(AbstractDocbkxMojo mojo)

Constructor setting the Mojo that holds the configuration.

Parameters:

mojo - The Mojo that holds the configuration.

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Fix man page file locations.
Man page generation replaces spaces in path name with underscores. As a result, if man pages are built in a project directory like /path/to/My Doc Project, then the generated man pages end up by default in /path/to/My_Doc_Project/target/docbkx/manpages.
This method copies the result to the expected location.
This method then attempts to remove the extra generated directory, though failure to remove the extra directory only logs an informational message and does no throw an exception.

Throws:

org.apache.maven.plugin.MojoExecutionException - Failed to copy files.