en-US/Help.psd1
|
@{ Parameters=@{ WhatIf='Shows the intended operation without downloads, file changes, process termination or elevation.' Confirm='Requests confirmation through PowerShell ShouldProcess. Explicit confirmation is honored; cannot be combined with Quiet.' Path='Absolute local managed installation root. The official payload stays in its VSO7 child to prevent upstream first-run relocation. Spaces and Unicode are supported. UNC, temporary, protected root, linked and shell-metacharacter paths are rejected. Never defaults to the working directory.' Scope='CurrentUser or AllUsers. CurrentUser is the safe default in automation; interactive Install-VSO asks when scope and path were omitted.' AllUsers='Selects AllUsers. Conflicts with an explicit Scope CurrentUser. AllUsers requires an administrator and a protected existing parent folder.' Version='VSO release semantic version, with optional v prefix. Independent of this module version. Update -Force permits an explicit downgrade or reinstall.' Prerelease='Includes preliminary releases. Required when explicitly selecting a prerelease version. Omitted by default.' AssetName='Exact distribution ZIP asset name listed in the official release. Required if more than one ZIP is present.' Force='Suppresses default confirmation when Confirm was not explicitly set. Permits a verified reinstall or downgrade. For Stop, explicitly permits forced termination. Never bypasses safety checks.' Quiet='No questions, windows, UAC, or progress. Uses safe install defaults. Ambiguous selection or required elevation fails. Reset additionally requires Force.' Language='es, es-ES, en or en-US. Spanish culture variants use Spanish; all other languages fall back to English. Defaults to PSUICulture.' PassThru='Returns a structured operation result or Help-VSO metadata. Reset -WhatIf -PassThru returns the exact removal plan.' Full='Also removes unchanged receipted configuration, cache, logs, temporary data and safely attributable manager transaction metadata. Shared VSO7 state and runtime files without ownership evidence remain preserved. Does not undo Windows tweaks or uninstall this module.' RemoveBackups='Also removes unchanged owned application files in previous manager transaction copies. Requires Full and AcknowledgeBackupLoss. Unknown backup files and shared Recovery remain preserved.' AcknowledgeBackupLoss='Explicitly acknowledges loss of previous application copies. Required with RemoveBackups, including automation.' AllowUnregistered='Explicitly permits launching a manually installed distribution after layout and internal checksum validation. Its official origin has not been established by this manager.' Command='Public command to describe. Omit to list all eight commands.' Examples='Show examples for the selected command.' } Defaults=@{WhatIf='False';Confirm='ConfirmPreference';Scope='CurrentUser in automation; interactive choice otherwise';Language='PSUICulture with explicit English fallback';Path='LOCALAPPDATA\Programs\VSO or ProgramFiles\VSO';Version='Latest stable release for Install/Update; all matching versions for discovery';Prerelease='False';Force='False';Quiet='False';Full='False';RemoveBackups='False';AcknowledgeBackupLoss='False';PassThru='False';AllowUnregistered='False';Examples='False'} 'Install-VSO'=@{Synopsis='Download, validate and install the official VSO distribution.';Description='Interactive scope and folder selection use native choices. An explicit Scope or AllUsers skips only scope selection; an interactive invocation still asks for the destination. Path alone selects CurrentUser without questions. CurrentUser uses LOCALAPPDATA; AllUsers uses ProgramFiles. GitHub release assets, archive SHA-256, extraction limits and every internal file checksum are validated before promotion. Unknown files are preserved and an existing installation requires Update or Force. Quiet never elevates. WhatIf creates no files and makes no network request.';Examples=@(@{Title='Interactive installation';Code='Install-VSO';Remarks='Choose scope and the default path, or select a folder.'},@{Title='Automated user installation';Code='Install-VSO -Scope CurrentUser -Version 1.2.2 -Quiet -PassThru';Remarks='No prompts; safe defaults are used.'},@{Title='Custom path';Code='Install-VSO -Path "D:\Programs\VSO" -Language es';Remarks='An absolute explicit path resolves the folder decision.'},@{Title='All users preview';Code='Install-VSO -AllUsers -WhatIf';Remarks='No UAC, lock, download or staging is created.'})} 'Start-VSO'=@{Synopsis='Open the selected installation through its official launcher.';Description='Revalidates owned files and START VSO7.bat. The batch launcher selects Windows PowerShell 5.1 and owns VSO elevation. Existing instances are detected conservatively. Missing process visibility causes a safe error. Start has no Quiet switch because it intentionally opens an application window. PassThru reports launcher creation, not successful application startup. Manual installations require AllowUnregistered.';Examples=@(@{Title='Launch';Code='Start-VSO';Remarks='Select among multiple installations if necessary.'},@{Title='Launch a selected installation';Code='Start-VSO -Path "D:\Programs\VSO" -PassThru';Remarks='Inspect LauncherProcessId and StartupVerified.'})} 'Stop-VSO'=@{Synopsis='Close only strictly attributed VSO processes.';Description='Matches the exact official launcher, script path or the protected memory host source and SHA-256. Does not terminate Windows Terminal or arbitrary descendants. PID creation time and command line are checked again before termination. VSO7 has no verified clean IPC shutdown contract: without Force, close VSO yourself. Force explicitly permits interruption, potentially during Recovery. Incomplete process visibility fails safely; interactive Force may request UAC.';Examples=@(@{Title='Preview';Code='Stop-VSO -Path "D:\Programs\VSO" -WhatIf';Remarks='Inspect the attributed PIDs.'},@{Title='Explicit forced termination';Code='Stop-VSO -Path "D:\Programs\VSO" -Force -PassThru';Remarks='Use only after considering pending work and Recovery.'})} 'Update-VSO'=@{Synopsis='Update a managed installation with verified transactional replacement.';Description='Uses official releases and semantic version precedence. Equal or older versions are skipped unless Force was explicitly supplied. Unknown files, configuration and backups are copied to the next installation; the previous directory is retained. Failures restore the previous directory where possible. An interrupted ambiguous transaction fails with its journal path. Running or insufficiently visible VSO processes block replacement. Cross-generation migration is rejected.';Examples=@(@{Title='Stable update';Code='Update-VSO -Quiet -PassThru';Remarks='Requires one unambiguous installation and sufficient permissions.'},@{Title='Preview';Code='Update-VSO -Path "D:\Programs\VSO" -WhatIf';Remarks='No download, elevation or replacement.'},@{Title='Explicit reinstall';Code='Update-VSO -Version 1.2.2 -Force';Remarks='Integrity and ownership checks remain mandatory.'})} 'Get-VSOInstallation'=@{Synopsis='Enumerate registered installations and limited default-folder discoveries.';Description='No matches returns an empty collection, including in interactive use; use Get-VSOStatus for an explicit absence summary. An explicit absent Path returns Missing; malformed/incomplete folders are Modified; local valid distributions without receipts are Unregistered. Index access errors are errors, not empty results. Path accepts pipeline strings or objects with a Path property. Returns structured objects with version, generation, scope, path, state, receipt and diagnostics. Does not prompt or scan drives. Path also inspects a manual installation; internal checksums do not prove its official origin. Missing or modified installations are reported explicitly. No files or registry keys are created.';Examples=@(@{Title='List';Code='Get-VSOInstallation | Select-Object Version, Scope, Path, State';Remarks='Objects can be filtered and used in scripts.'},@{Title='Inspect a custom folder';Code='Get-VSOInstallation -Path "D:\Programs\VSO" -Language es';Remarks='Read-only inspection.'})} 'Get-VSOStatus'=@{Synopsis='Report installation integrity and attributable process activity.';Description='Returns one VSO.Status summary with Kind Summary and InstallationState NotInstalled when no installation matches. This is a query result, not an installation record. Missing values are null and Running is a Boolean (null for unknown process visibility). Native display is localized; Select-Object and JSON retain the raw properties. Scope and Version filter the query; an empty filtered result does not prove global absence. Path accepts pipeline strings or objects with a Path property. Read-only, structured status. ProcessState Unknown means visibility was insufficient; Idle only means that no attributed process was found with available evidence. Status does not check Internet updates or claim VSO finished startup. No confirmations or writes.';Examples=@(@{Title='Status';Code='Get-VSOStatus -Quiet | Format-List';Remarks='Includes state diagnostics and process visibility.'})} 'Reset-VSO'=@{Synopsis='Remove owned application files while preserving Windows Recovery and unknown data.';Description='Application and module removal are independent. Reset-VSO removes the application; Reset-VSO -Full includes additional attributable data. Uninstall-PSResource VSO removes the module, or use Uninstall-Module VSO for PowerShellGet. Neither action removes the other component. Always preview with WhatIf and PassThru. Displays exact deletion and preservation lists. Normal reset removes unchanged application files and matching registration/receipt while preserving receipted persistent data. Full also removes unchanged receipted configuration, cache, logs, temporary files and attributable transaction metadata. Protected objects include explicit ownership reasons; shared or untracked data cannot be completely cleaned. Modified and foreign files survive. Full cannot attribute VSO7 shared ProgramData or untracked runtime data to one installation, so those are preserved. RemoveBackups plus AcknowledgeBackupLoss explicitly permits deletion of owned previous application copies. Quiet/non-interactive destructive execution requires Force. Uninstalling files does not reverse any Windows tweak. The Gallery module itself remains installed.';Examples=@(@{Title='Inspect exact plan';Code='Reset-VSO -Path "D:\Programs\VSO" -Full -WhatIf -PassThru';Remarks='Review Remove, Preserve and Protected (reason and ownership).'},@{Title='Remove application';Code='Reset-VSO -Path "D:\Programs\VSO" -Quiet -Force -PassThru';Remarks='Preserves shared Recovery and files without ownership proof.'},@{Title='Explicit manager backup removal';Code='Reset-VSO -Full -RemoveBackups -AcknowledgeBackupLoss -Confirm';Remarks='Also removes attributable previous application files, preserving unknown content.'},@{Title='Remove the PowerShell module';Code='Uninstall-PSResource VSO';Remarks='For PowerShellGet use Uninstall-Module VSO. The application is retained. Close sessions that have imported the module before uninstalling it.'})} 'Help-VSO'=@{Synopsis='Show localized help, syntax, parameters and examples.';Description='The overview also explains application/module removal. Examples requires Command. Get-Help -Full displays examples after NOTES without a separate general examples heading; numbered example titles distinguish them. Get-Help -Examples selects the structured examples only. Selects Spanish for Spanish UI cultures and English for all others. Language overrides this decision for Help-VSO. Native Get-Help uses generated localized external MAML in en-US and es-ES, with an English root fallback; Get-Help uses the session UI culture, not this command Language parameter. All help is generated from the same structured descriptions.';Examples=@(@{Title='Spanish help';Code='Help-VSO -Command Install-VSO -Language es';Remarks='Explicit language override.'},@{Title='Native help';Code='Get-Help Reset-VSO -Full';Remarks='Uses the native PowerShell help culture selection.'})} } |