netstandard2.0/en-US/Zstd.Shell.b22701d907f5f9bb.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Compress-Zstd</command:name><command:verb>Compress</command:verb><command:noun>Zstd</command:noun><maml:description><maml:para>Compresses files, or bytes, with Zstandard.</maml:para></maml:description></command:details><maml:description><maml:para>With -Path or -LiteralPath, each file named is compressed on its own: a file that fails gets its own error record and the rest go on. Files piped from Get-ChildItem or Get-Item bind to -LiteralPath by their PSPath. A file is mapped into memory and handed to libzstd 1 MiB more at a time, or read in 1 MiB chunks when Windows will not map it or, within -MaxMemory, its map does not fit, and written to a temporary file beside its destination that is renamed onto it only when complete. The destination is the file's name with .zst added, beside it, unless -DestinationPath names a folder to write into or one file, which only the first input of the command may take. With -InputObject, a single byte[] is compressed in one piece, and the records of a longer pipeline are fed to libzstd as they arrive; the result is written as one byte[] when the pipeline ends. Every result is one zstd frame with a content checksum, whose header records the content size for a file or a single byte[].</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Compress-Zstd</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>The files to compress. Wildcard characters select every file they match, and a relative path is resolved against the current PowerShell location.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name with .zst added. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>DictionaryPath</maml:name><maml:description><maml:para>A dictionary file, named exactly as written: one in zstd's format, whose id each frame's header then records, or any other file, whose bytes are used as raw content. Expanding the output needs the same dictionary.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Level</maml:name><maml:description><maml:para>The compression level, 1 to 22. Higher levels trade speed for a smaller output. The default is 3, libzstd's own default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Threads</maml:name><maml:description><maml:para>Worker threads libzstd compresses with, 0 to 256. The default, 0, compresses on the calling thread.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes, estimated before any work starts, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result, which is held in memory twice. A file whose map does not fit is read a chunk at a time. Compression uses as many of the -Threads worker threads as fit, and is refused when the calling thread, or one worker, does not fit. Without it, compression uses the worker threads asked for.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Compress-Zstd</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>The files to compress. Wildcard characters select every file they match, and a relative path is resolved against the current PowerShell location.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name with .zst added. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Dictionary</maml:name><maml:description><maml:para>A dictionary as a byte[], taken as -DictionaryPath takes a file's bytes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Level</maml:name><maml:description><maml:para>The compression level, 1 to 22. Higher levels trade speed for a smaller output. The default is 3, libzstd's own default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Threads</maml:name><maml:description><maml:para>Worker threads libzstd compresses with, 0 to 256. The default, 0, compresses on the calling thread.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes, estimated before any work starts, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result, which is held in memory twice. A file whose map does not fit is read a chunk at a time. Compression uses as many of the -Threads worker threads as fit, and is refused when the calling thread, or one worker, does not fit. Without it, compression uses the worker threads asked for.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Compress-Zstd</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>LiteralPath</maml:name><maml:description><maml:para>The files to compress, each named exactly as written, wildcard characters included. A file piped from Get-ChildItem or Get-Item binds here by its PSPath.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name with .zst added. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>DictionaryPath</maml:name><maml:description><maml:para>A dictionary file, named exactly as written: one in zstd's format, whose id each frame's header then records, or any other file, whose bytes are used as raw content. Expanding the output needs the same dictionary.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Level</maml:name><maml:description><maml:para>The compression level, 1 to 22. Higher levels trade speed for a smaller output. The default is 3, libzstd's own default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Threads</maml:name><maml:description><maml:para>Worker threads libzstd compresses with, 0 to 256. The default, 0, compresses on the calling thread.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes, estimated before any work starts, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result, which is held in memory twice. A file whose map does not fit is read a chunk at a time. Compression uses as many of the -Threads worker threads as fit, and is refused when the calling thread, or one worker, does not fit. Without it, compression uses the worker threads asked for.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Compress-Zstd</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>LiteralPath</maml:name><maml:description><maml:para>The files to compress, each named exactly as written, wildcard characters included. A file piped from Get-ChildItem or Get-Item binds here by its PSPath.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name with .zst added. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Dictionary</maml:name><maml:description><maml:para>A dictionary as a byte[], taken as -DictionaryPath takes a file's bytes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Level</maml:name><maml:description><maml:para>The compression level, 1 to 22. Higher levels trade speed for a smaller output. The default is 3, libzstd's own default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Threads</maml:name><maml:description><maml:para>Worker threads libzstd compresses with, 0 to 256. The default, 0, compresses on the calling thread.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes, estimated before any work starts, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result, which is held in memory twice. A file whose map does not fit is read a chunk at a time. Compression uses as many of the -Threads worker threads as fit, and is refused when the calling thread, or one worker, does not fit. Without it, compression uses the worker threads asked for.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Compress-Zstd</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""><maml:name>InputObject</maml:name><maml:description><maml:para>The bytes to compress, as a byte[]. A single byte piped from an enumerated array arrives as a byte[] of one, and an empty byte[] compresses to a frame of nothing. A $null record, or no -InputObject at all where the bytes are expected, is refused with ZstdNoInput.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>DictionaryPath</maml:name><maml:description><maml:para>A dictionary file, named exactly as written: one in zstd's format, whose id each frame's header then records, or any other file, whose bytes are used as raw content. Expanding the output needs the same dictionary.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Level</maml:name><maml:description><maml:para>The compression level, 1 to 22. Higher levels trade speed for a smaller output. The default is 3, libzstd's own default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Threads</maml:name><maml:description><maml:para>Worker threads libzstd compresses with, 0 to 256. The default, 0, compresses on the calling thread.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes, estimated before any work starts, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result, which is held in memory twice. A file whose map does not fit is read a chunk at a time. Compression uses as many of the -Threads worker threads as fit, and is refused when the calling thread, or one worker, does not fit. Without it, compression uses the worker threads asked for.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Compress-Zstd</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""><maml:name>InputObject</maml:name><maml:description><maml:para>The bytes to compress, as a byte[]. A single byte piped from an enumerated array arrives as a byte[] of one, and an empty byte[] compresses to a frame of nothing. A $null record, or no -InputObject at all where the bytes are expected, is refused with ZstdNoInput.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Dictionary</maml:name><maml:description><maml:para>A dictionary as a byte[], taken as -DictionaryPath takes a file's bytes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Level</maml:name><maml:description><maml:para>The compression level, 1 to 22. Higher levels trade speed for a smaller output. The default is 3, libzstd's own default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Threads</maml:name><maml:description><maml:para>Worker threads libzstd compresses with, 0 to 256. The default, 0, compresses on the calling thread.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes, estimated before any work starts, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result, which is held in memory twice. A file whose map does not fit is read a chunk at a time. Compression uses as many of the -Threads worker threads as fit, and is refused when the calling thread, or one worker, does not fit. Without it, compression uses the worker threads asked for.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>The files to compress. Wildcard characters select every file they match, and a relative path is resolved against the current PowerShell location.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue><dev:type><maml:name>string[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>LiteralPath</maml:name><maml:description><maml:para>The files to compress, each named exactly as written, wildcard characters included. A file piped from Get-ChildItem or Get-Item binds here by its PSPath.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue><dev:type><maml:name>string[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name with .zst added. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""><maml:name>InputObject</maml:name><maml:description><maml:para>The bytes to compress, as a byte[]. A single byte piped from an enumerated array arrives as a byte[] of one, and an empty byte[] compresses to a frame of nothing. A $null record, or no -InputObject at all where the bytes are expected, is refused with ZstdNoInput.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue><dev:type><maml:name>byte[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>DictionaryPath</maml:name><maml:description><maml:para>A dictionary file, named exactly as written: one in zstd's format, whose id each frame's header then records, or any other file, whose bytes are used as raw content. Expanding the output needs the same dictionary.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Dictionary</maml:name><maml:description><maml:para>A dictionary as a byte[], taken as -DictionaryPath takes a file's bytes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue><dev:type><maml:name>byte[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Level</maml:name><maml:description><maml:para>The compression level, 1 to 22. Higher levels trade speed for a smaller output. The default is 3, libzstd's own default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue><dev:type><maml:name>int</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Threads</maml:name><maml:description><maml:para>Worker threads libzstd compresses with, 0 to 256. The default, 0, compresses on the calling thread.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue><dev:type><maml:name>int</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes, estimated before any work starts, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result, which is held in memory twice. A file whose map does not fit is read a chunk at a time. Compression uses as many of the -Threads worker threads as fit, and is refused when the calling thread, or one worker, does not fit. Without it, compression uses the worker threads asked for.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue><dev:type><maml:name>long</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>byte[]</maml:name></dev:type><maml:description><maml:para>The bytes to compress, as a byte[]. A single byte piped from an enumerated array arrives as a byte[] of one, and an empty byte[] compresses to a frame of nothing. A $null record, or no -InputObject at all where the bytes are expected, is refused with ZstdNoInput.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>System.IO.FileInfo</maml:name></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>System.Byte[]</maml:name></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><dev:code>Compress-Zstd -Path .\app.log</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><dev:code>Compress-Zstd -Path .\logs\*.log -DestinationPath .\archive -PassThru</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><dev:code>Get-ChildItem .\logs -Filter *.log | Compress-Zstd -Level 19</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example><command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title><dev:code>Compress-Zstd -Path .\app.log -DestinationPath .\app.log.zst -Level 19 -Threads 4 -Force</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example><command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title><dev:code>$packed = Compress-Zstd -InputObject ([System.Text.Encoding]::UTF8.GetBytes('hello'))</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example></command:examples></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>Expand-Zstd</command:name><command:verb>Expand</command:verb><command:noun>Zstd</command:noun><maml:description><maml:para>Expands Zstandard-compressed data from files, or bytes.</maml:para></maml:description></command:details><maml:description><maml:para>With -Path or -LiteralPath, each file named is expanded on its own: a file that fails gets its own error record and the rest go on. Files piped from Get-ChildItem or Get-Item bind to -LiteralPath by their PSPath. A file is expanded in 1 MiB chunks into a temporary file. A frame whose window does not fit that way, over 128 MiB without -MaxMemory or taking more than -MaxMemory to expand, sends the file to be written in place instead, through a map of it and of a temporary file as long as its frames' content sizes add up to, when every frame records its content size. The temporary file is beside the destination and is renamed onto it only when complete. The destination is the file's name without its .zst, beside it, unless -DestinationPath names a folder to write into or one file, which only the first input of the command may take; a file not named .zst needs -DestinationPath. With -InputObject, the result is written as one byte[] when the pipeline ends. A first record whose frames all record their content size, as the frames Compress-Zstd writes from a file or a single byte[] do, is expanded straight into a byte[] of the size they add up to, which takes a frame of any window; other bytes, and the records after the first, are fed to libzstd as they arrive. Every frame in the input is expanded, in order. Input that is empty, ends inside a frame, holds bytes after a frame that do not begin another, or fails a frame's checksum is refused with an error record, and nothing is written.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Expand-Zstd</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>The files to expand. Wildcard characters select every file they match, and a relative path is resolved against the current PowerShell location.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name without .zst. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>DictionaryPath</maml:name><maml:description><maml:para>The dictionary the data was compressed with, as a file named exactly as written. A frame whose header names a dictionary other than this one is refused.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes for a frame's window, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result. The result is held in memory once when the bytes are one record whose frames all record their content size, expanded straight into the byte[] written with no window, and twice otherwise, as it is built and as the byte[] written. A frame that does not fit a chunk at a time sends a file to be written in place, which takes a frame of any window, when all its frames record their content size and the page tables of both files' maps fit; otherwise the frame is refused. Without it, a frame expanded a chunk at a time may have a window of up to 128 MiB, libzstd's own limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Expand-Zstd</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>The files to expand. Wildcard characters select every file they match, and a relative path is resolved against the current PowerShell location.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name without .zst. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Dictionary</maml:name><maml:description><maml:para>The dictionary the data was compressed with, as a byte[], taken as -DictionaryPath takes a file's bytes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes for a frame's window, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result. The result is held in memory once when the bytes are one record whose frames all record their content size, expanded straight into the byte[] written with no window, and twice otherwise, as it is built and as the byte[] written. A frame that does not fit a chunk at a time sends a file to be written in place, which takes a frame of any window, when all its frames record their content size and the page tables of both files' maps fit; otherwise the frame is refused. Without it, a frame expanded a chunk at a time may have a window of up to 128 MiB, libzstd's own limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Expand-Zstd</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>LiteralPath</maml:name><maml:description><maml:para>The files to expand, each named exactly as written, wildcard characters included. A file piped from Get-ChildItem or Get-Item binds here by its PSPath.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name without .zst. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>DictionaryPath</maml:name><maml:description><maml:para>The dictionary the data was compressed with, as a file named exactly as written. A frame whose header names a dictionary other than this one is refused.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes for a frame's window, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result. The result is held in memory once when the bytes are one record whose frames all record their content size, expanded straight into the byte[] written with no window, and twice otherwise, as it is built and as the byte[] written. A frame that does not fit a chunk at a time sends a file to be written in place, which takes a frame of any window, when all its frames record their content size and the page tables of both files' maps fit; otherwise the frame is refused. Without it, a frame expanded a chunk at a time may have a window of up to 128 MiB, libzstd's own limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Expand-Zstd</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>LiteralPath</maml:name><maml:description><maml:para>The files to expand, each named exactly as written, wildcard characters included. A file piped from Get-ChildItem or Get-Item binds here by its PSPath.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name without .zst. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Dictionary</maml:name><maml:description><maml:para>The dictionary the data was compressed with, as a byte[], taken as -DictionaryPath takes a file's bytes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes for a frame's window, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result. The result is held in memory once when the bytes are one record whose frames all record their content size, expanded straight into the byte[] written with no window, and twice otherwise, as it is built and as the byte[] written. A frame that does not fit a chunk at a time sends a file to be written in place, which takes a frame of any window, when all its frames record their content size and the page tables of both files' maps fit; otherwise the frame is refused. Without it, a frame expanded a chunk at a time may have a window of up to 128 MiB, libzstd's own limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Expand-Zstd</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""><maml:name>InputObject</maml:name><maml:description><maml:para>The zstd data to expand, as a byte[]. A single byte piped from an enumerated array arrives as a byte[] of one. A $null record, or no -InputObject at all where the bytes are expected, is refused with ZstdNoInput.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>DictionaryPath</maml:name><maml:description><maml:para>The dictionary the data was compressed with, as a file named exactly as written. A frame whose header names a dictionary other than this one is refused.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes for a frame's window, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result. The result is held in memory once when the bytes are one record whose frames all record their content size, expanded straight into the byte[] written with no window, and twice otherwise, as it is built and as the byte[] written. A frame that does not fit a chunk at a time sends a file to be written in place, which takes a frame of any window, when all its frames record their content size and the page tables of both files' maps fit; otherwise the frame is refused. Without it, a frame expanded a chunk at a time may have a window of up to 128 MiB, libzstd's own limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Expand-Zstd</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""><maml:name>InputObject</maml:name><maml:description><maml:para>The zstd data to expand, as a byte[]. A single byte piped from an enumerated array arrives as a byte[] of one. A $null record, or no -InputObject at all where the bytes are expected, is refused with ZstdNoInput.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Dictionary</maml:name><maml:description><maml:para>The dictionary the data was compressed with, as a byte[], taken as -DictionaryPath takes a file's bytes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes for a frame's window, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result. The result is held in memory once when the bytes are one record whose frames all record their content size, expanded straight into the byte[] written with no window, and twice otherwise, as it is built and as the byte[] written. A frame that does not fit a chunk at a time sends a file to be written in place, which takes a frame of any window, when all its frames record their content size and the page tables of both files' maps fit; otherwise the frame is refused. Without it, a frame expanded a chunk at a time may have a window of up to 128 MiB, libzstd's own limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>The files to expand. Wildcard characters select every file they match, and a relative path is resolved against the current PowerShell location.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue><dev:type><maml:name>string[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>LiteralPath</maml:name><maml:description><maml:para>The files to expand, each named exactly as written, wildcard characters included. A file piped from Get-ChildItem or Get-Item binds here by its PSPath.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue><dev:type><maml:name>string[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>Where to write. Without it, each file is written beside itself under its name without .zst. An existing folder receives each file under that name; any other path is one file, which only the first input of the command may take.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""><maml:name>InputObject</maml:name><maml:description><maml:para>The zstd data to expand, as a byte[]. A single byte piped from an enumerated array arrives as a byte[] of one. A $null record, or no -InputObject at all where the bytes are expected, is refused with ZstdNoInput.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue><dev:type><maml:name>byte[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>DictionaryPath</maml:name><maml:description><maml:para>The dictionary the data was compressed with, as a file named exactly as written. A frame whose header names a dictionary other than this one is refused.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Dictionary</maml:name><maml:description><maml:para>The dictionary the data was compressed with, as a byte[], taken as -DictionaryPath takes a file's bytes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">byte[]</command:parameterValue><dev:type><maml:name>byte[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxMemory</maml:name><maml:description><maml:para>The most memory, in bytes, the command may commit, 1MB or more: what libzstd takes for a frame's window, a dictionary, the command's own buffers, the page tables of a file's map, and on bytes the result. The result is held in memory once when the bytes are one record whose frames all record their content size, expanded straight into the byte[] written with no window, and twice otherwise, as it is built and as the byte[] written. A frame that does not fit a chunk at a time sends a file to be written in place, which takes a frame of any window, when all its frames record their content size and the page tables of both files' maps fit; otherwise the frame is refused. Without it, a frame expanded a chunk at a time may have a window of up to 128 MiB, libzstd's own limit.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">long</command:parameterValue><dev:type><maml:name>long</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of each file written.</maml:para></maml:description><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>byte[]</maml:name></dev:type><maml:description><maml:para>The zstd data to expand, as a byte[]. A single byte piped from an enumerated array arrives as a byte[] of one. A $null record, or no -InputObject at all where the bytes are expected, is refused with ZstdNoInput.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>System.IO.FileInfo</maml:name></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>System.Byte[]</maml:name></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><dev:code>Expand-Zstd -Path .\app.log.zst</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><dev:code>Expand-Zstd -Path .\archive\*.zst -DestinationPath .\restored -PassThru</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><dev:code>Get-ChildItem .\archive -Filter *.zst | Expand-Zstd -DestinationPath .\restored</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example><command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title><dev:code>$bytes = Expand-Zstd -InputObject $packed</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example></command:examples></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name>New-ZstdDictionary</command:name><command:verb>New</command:verb><command:noun>ZstdDictionary</command:noun><maml:description><maml:para>Trains a Zstandard dictionary from sample files.</maml:para></maml:description></command:details><maml:description><maml:para>Each file -Path or -LiteralPath names is one sample, and files piped from Get-ChildItem or Get-Item bind to -LiteralPath by their PSPath. The samples are read into memory together, since libzstd's trainer takes them as one buffer, and the dictionary it trains, at most -MaxSize bytes, is written to -DestinationPath through a temporary file beside it that is renamed onto it only when complete. A sample that cannot be read gets its own error record, and training goes on with the rest. libzstd's trainer needs at least 7 samples and 8 bytes of them in all, and refuses 4294967295 bytes or more in all. Training runs in libzstd without a pause, so a stop during it takes effect when it returns, and nothing is written.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>New-ZstdDictionary</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>The sample files, each one sample. Wildcard characters select every file they match, and a relative path is resolved against the current PowerShell location.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>The file to write the dictionary to. A folder is refused.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxSize</maml:name><maml:description><maml:para>The largest dictionary to train, in bytes, 256 to 2147483647. The default, 112640, is the zstd command line tool's.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of the dictionary written.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>New-ZstdDictionary</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>LiteralPath</maml:name><maml:description><maml:para>The sample files, each one sample, named exactly as written, wildcard characters included. A file piped from Get-ChildItem or Get-Item binds here by its PSPath.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>The file to write the dictionary to. A folder is refused.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxSize</maml:name><maml:description><maml:para>The largest dictionary to train, in bytes, 256 to 2147483647. The default, 112640, is the zstd command line tool's.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of the dictionary written.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>The sample files, each one sample. Wildcard characters select every file they match, and a relative path is resolved against the current PowerShell location.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue><dev:type><maml:name>string[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>LiteralPath</maml:name><maml:description><maml:para>The sample files, each one sample, named exactly as written, wildcard characters included. A file piped from Get-ChildItem or Get-Item binds here by its PSPath.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string[]</command:parameterValue><dev:type><maml:name>string[]</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="1" aliases=""><maml:name>DestinationPath</maml:name><maml:description><maml:para>The file to write the dictionary to. A folder is refused.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>MaxSize</maml:name><maml:description><maml:para>The largest dictionary to train, in bytes, 256 to 2147483647. The default, 112640, is the zstd command line tool's.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">int</command:parameterValue><dev:type><maml:name>int</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Replaces a destination file that exists.</maml:para></maml:description><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases=""><maml:name>PassThru</maml:name><maml:description><maml:para>Writes the FileInfo of the dictionary written.</maml:para></maml:description><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>None</dev:defaultValue></command:parameter></command:parameters><command:inputTypes></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>System.IO.FileInfo</maml:name></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><dev:code>New-ZstdDictionary -Path .\samples\*.json -DestinationPath .\json.dict</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><dev:code>Get-ChildItem .\samples -Filter *.json | New-ZstdDictionary -DestinationPath .\json.dict</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><dev:code>New-ZstdDictionary -Path .\logs\*.log -DestinationPath .\logs.dict -MaxSize 65536 -Force -PassThru</dev:code><dev:remarks><maml:para></maml:para></dev:remarks></command:example></command:examples></command:command> </helpItems> |