Install-MAML

NAME Install-MAML



SYNOPSIS

Installs MAML into a module





SYNTAX

Install-MAML [-Module] <System.String[]> [-NoRefresh <Switch>] [-Compact <Switch>] [[-ScriptName] <String>]

[-FunctionRoot <System.String[]>] [-NoRecurse <Switch>] [[-Encoding] <System.Text.Encoding>] [-Exclude

<System.String[]>] [-NoVersion <Switch>] [-Culture <Cultureinfo>] [-PassThru <Switch>] [<CommonParameters>]





DESCRIPTION

Installs MAML into a module.



This generates a single script that:



* Includes all commands



* Removes their multiline comments



* Directs the commands to use external help



You should then include this script in your module import.



Ideally, you should use the allcommands script





PARAMETERS

-Compact [<Switch>]

If set, will compact the generated MAML. This will be ignored if -Refresh is not passed, since no new MAML

will be generated.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Culture [<Cultureinfo>]

If provided, will save the MAML to a different directory than the current UI culture.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Encoding [<System.Text.Encoding>]

The encoding of the combined script. By default, UTF8.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Exclude [<System.String[]>]

A list of wildcards to exclude. This list will always contain the ScriptName.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-FunctionRoot [<System.String[]>]

The root directories containing functions. If not provided, the function root will be the module root.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Module [<System.String[]>]

The name of one or more modules.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-NoRecurse [<Switch>]

If set, the function roots will not be recursively searched.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-NoRefresh [<Switch>]

If set, will refresh the documentation for the module before generating the commands file.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-NoVersion [<Switch>]

If set, the generate MAML will not contain a version number.

This slightly reduces the size of the MAML file, and reduces the rate of changes in the MAML file.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-PassThru [<Switch>]

If set, will return the files that were generated.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ScriptName [<String>]

The name of the combined script. By default, allcommands.ps1.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

System.Nullable



System.IO.FileInfo





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Install-MAML -Module HelpOut





RELATED LINKS

Save-MAML

ConvertTo-MAML