Skip to content

Add note about supported formats. #11378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 3, 2024
Merged

Add note about supported formats. #11378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions reference/7.4/Microsoft.PowerShell.Archive/Compress-Archive.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Archive-help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Archive
ms.date: 03/03/2023
ms.date: 09/03/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.archive/compress-archive?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Compress-Archive
Expand All @@ -11,7 +11,7 @@ title: Compress-Archive
# Compress-Archive

## SYNOPSIS
Creates a compressed archive, or zipped file, from specified files and directories.
Creates a compressed ZIP archive from specified files and directories.

## SYNTAX

Expand Down Expand Up @@ -65,7 +65,8 @@ a single zipped file for easier distribution and storage. An archive file can be
the compression algorithm specified by the **CompressionLevel** parameter.

The `Compress-Archive` cmdlet uses the **System.IO.Compression.ZipArchive** API to compress files.
The API limits the maximum file size to 2GB. For more information, see
The API limits the maximum file size to 2GB. The .NET API works with files that conform to the
official ZIP file format specification by PKWARE Inc. For more information, see
[System.IO.Compression.ZipArchive](xref:System.IO.Compression.ZipArchive).

> [!NOTE]
Expand Down
9 changes: 7 additions & 2 deletions reference/7.4/Microsoft.PowerShell.Archive/Expand-Archive.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Archive-help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Archive
ms.date: 10/06/2023
ms.date: 09/03/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.archive/expand-archive?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Expand-Archive
Expand All @@ -11,7 +11,7 @@ title: Expand-Archive
# Expand-Archive

## SYNOPSIS
Extracts files from a specified archive (zipped) file.
Extracts files from a specified ZIP archive file.

## SYNTAX

Expand All @@ -35,6 +35,11 @@ The `Expand-Archive` cmdlet extracts files from a specified zipped archive file
destination folder. An archive file allows multiple files to be packaged, and optionally compressed,
into a single zipped file for easier distribution and storage.

The `Expand-Archive` cmdlet uses the **System.IO.Compression.ZipArchive** API to compress files.
The API limits the maximum file size to 2GB. The .NET API works with files that conform to the
official ZIP file format specification by PKWARE Inc. For more information, see
[System.IO.Compression.ZipArchive](xref:System.IO.Compression.ZipArchive).

## EXAMPLES

### Example 1: Extract the contents of an archive
Expand Down
11 changes: 6 additions & 5 deletions reference/7.4/Microsoft.PowerShell.Archive/Microsoft.PowerShell.Archive.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Help Version: 7.4.0.0
Locale: en-US
Module Guid: eb74e8da-9ae2-482a-a648-e96550fb8733
Module Name: Microsoft.PowerShell.Archive
ms.date: 06/09/2017
ms.date: 09/03/2024
schema: 2.0.0
title: Microsoft.PowerShell.Archive
---
Expand All @@ -13,13 +13,14 @@ title: Microsoft.PowerShell.Archive

## Description

This section contains the help topics for the cmdlets that are installed with the PowerShell Microsoft.PowerShell.Archive module. The Archive module contains cmdlets that let you create and extract archive or ZIP files.
This section contains the help topics for the cmdlets that are installed with the PowerShell
Microsoft.PowerShell.Archive module. The Archive module contains cmdlets that let you manage ZIP
archive files.

## Microsoft.PowerShell.Archive Cmdlets

### [Compress-Archive](Compress-Archive.md)
Creates a compressed archive, or zipped file, from specified files and directories.
Creates a compressed ZIP archive from specified files and directories.

### [Expand-Archive](Expand-Archive.md)
Extracts files from a specified archive (zipped) file.

Extracts files from a specified ZIP archive file.