about_Updatable_Help

  • Makale

Kısa açıklama

PowerShell'de güncelleştirilebilir yardım sistemini açıklar.

Uzun açıklama

PowerShell, PowerShell cmdlet'leri ve kavramları için en güncel yardım konularına erişmek için çeşitli yollar sağlar.

PowerShell 3.0'da kullanıma sunulan Güncelleştirilebilir Yardım sistemi, komut satırında okuyabilmek için yerel bilgisayarınızda her zaman en yeni yardım konularına sahip olduğunuzdan emin olmak için tasarlanmıştır. Bu, yardım dosyalarını indirmeyi ve yüklemeyi ve yeni yardım dosyaları kullanılabilir olduğunda bunları güncelleştirmeyi kolaylaştırır.

Bir kuruluştaki birden çok bilgisayar ve İnternet erişimi olmayan bilgisayarlar için güncelleştirilmiş yardım sağlamak için Güncelleştirilebilir Yardım, yardım dosyalarını bir dosya sistemi dizinine veya dosya paylaşımına indirmenize ve ardından yardım dosyalarını dosya paylaşımından yüklemenize olanak tanır.

PowerShell 4.0'da HelpInfoUri özelliği, uzak bir bilgisayarda yüklü olan ancak yerel bilgisayarda yüklü olması gerekmeyen modüller için çalışmaya olanak tanıyan Save-Help Windows PowerShell uzaktan iletişiminde korunur. PSModuleInfo nesnesini İnternet erişimi olmayan bir bilgisayarda çalıştırarak, PSModuleInfo nesnesini internet erişimi olan bir bilgisayarda içeri aktararak ve ardından PSModuleInfo nesnesinde çalıştırarak Save-Helpdiske veya çıkarılabilir medyaya (USB sürücüsü gibi) kaydedebilirsiniz.Export-Clixml Kaydedilen yardım çıkarılabilir medya kullanılarak uzak, bağlantısı kesilmiş bilgisayara kopyalanabilir ve ardından çalıştırılarak Update-Helpyüklenebilir. İşlevsellikteki Save-Help bu geliştirmeler, herhangi bir ağ erişimi olmayan bilgisayarlara yardım yüklemenize olanak tanır. Yeni Save-Help işlevselliğin nasıl kullanılacağına ilişkin bir örnek için bu konudaki Bir dosya paylaşımından yardım güncelleştirme konusuna bakın.

Güncelleştirilebilir Yardım, bilgisayarda yardım dosyası olmasa bile en yeni yardım konularına çevrimiçi erişimi ve cmdlet'ler için temel yardımı da destekler.

PowerShell, Yardım dosyalarıyla birlikte gelmez. PowerShell'de varsayılan olarak bulunan tüm komutlar ve tüm Windows modülleri için yardım dosyalarını yüklemek için Güncelleştirilebilir Yardım özelliğini kullanabilirsiniz.

Güncelleştirilebilir yardım cmdlet'leri

  • Update-Help: İnternet'ten veya dosya paylaşımından en yeni yardım dosyalarını indirir ve bunları yerel bilgisayara yükler.

  • Save-Help: İnternet'ten en yeni yardım dosyalarını indirir ve bunları bir dosya sistemi dizinine veya dosya paylaşımına kaydeder. Yardım dosyalarını bilgisayarlara yüklemek için kullanın Update-Help.

  • Get-Help: Komut satırında yardım konularını görüntüler. Bilgisayardaki yardım dosyalarından yardım alır. Yardım dosyaları olmayan cmdlet'ler ve işlevler için otomatik olarak oluşturulan yardımı görüntüler. Varsayılan internet tarayıcınızda cmdlet'ler, işlevler, betikler ve iş akışları için çevrimiçi yardım konularını açar.

Otomatik oluşturulan yardım: yardım dosyaları olmadan yardım

Bilgisayarda bir cmdlet, işlev veya iş akışı için yardım dosyanız yoksa, Get-Help cmdlet otomatik olarak oluşturulan yardımı görüntüler ve yardım dosyalarını indirmenizi veya çevrimiçi okumanızı ister.

Otomatik olarak oluşturulan yardım söz dizimi ve diğer adlar ile Güncelleştirilebilir Yardım cmdlet'lerinin nasıl kullanılacağını ve çevrimiçi yardım konularına nasıl erişildiğini açıklayan açıklamalar içerir.

Örneğin, aşağıdaki komut cmdlet'i için Get-Culture temel yardım alır. Çıktı, bilgisayarda yardım dosyası olmadığında ekranı gösterir Get-Help .

Get-Help Get-Culture

NAME
    Get-Culture

SYNTAX
    Get-Culture [<CommonParameters>]

ALIASES
    None

REMARKS
    To get the latest Help content including descriptions and examples
    type: Update-Help.

Modüller için yardım dosyaları

Güncelleştirilebilir Yardım'ın en küçük birimi bir modül için yardımdır. Modül yardımı, modüldeki tüm cmdlet'ler, işlevler, iş akışları, sağlayıcılar, betikler ve kavramlar için yardım içerir. Geçerli oturuma aktarılmasalar bile bilgisayarda yüklü olan tüm modüller için yardımı güncelleştirebilirsiniz.

Modülün tamamı için yardımı güncelleştirebilirsiniz, ancak tek tek cmdlet'ler için yardımı güncelleştiremezsiniz.

Belirli bir cmdlet içeren modülü bulmak için aşağıdaki komut biçimini kullanın:

(Get-Command <cmdlet-name>).ModuleName

Örneğin, cmdlet'ini içeren Set-ExecutionPolicy modülü bulmak için şunu yazın:

(Get-Command Set-ExecutionPolicy).ModuleName

Belirli bir modülle ilgili yardımı güncelleştirmek için şunu yazın:

Update-Help -Module <ModuleName>

Örneğin, Set-ExecutionPolicy cmdlet'ini içeren modülün yardımını güncelleştirmek için şunu yazın:

Update-Help -Module Microsoft.PowerShell.Security

Güncelleştirilebilir yardım için izinler

dizinindeki $pshome/Modulesmodüllerin yardımını güncelleştirmek için bilgisayardaki Yönetici istrators grubunun üyesi olmanız gerekir.

Yönetici istrators grubunun üyesi değilseniz, bu modüllerle ilgili yardımı güncelleştiremezsiniz, ancak İnternet erişiminiz varsa çevrimiçi yardım görüntüleyebilirsiniz.

Dizindeki modüllerin veya dizinin $HOME/Documents/PowerShell/Modules diğer alt dizinlerindeki modüllerin güncelleştirilmesi $HOME için özel izinler gerekmez.

ve Save-Help cmdlet'leriUpdate-Help, geçerli kullanıcının açık kimlik bilgilerini sağlayan bir UseDefaultCredentials parametresine sahiptir. Bu parametre, güvenli İnternet konumlarına erişmek için tasarlanmıştır.

ve cmdlet'leriUpdate-Help, komutu uzak bir bilgisayarda çalıştırmanıza ve üçüncü bir bilgisayardaki dosya paylaşımına erişmenize olanak tanıyan bir Credential parametresine de sahiptir.Save-Help Credential parametresi yalnızca için SourcePath veya LiteralPath parametrelerini Update-Help ve DestinationPath veya LiteralPath parametrelerini Save-Helpkullandığınızda geçerlidir.

Yardım dosyalarını yükleme ve güncelleştirme

Yardım dosyalarını ilk kez indirip yüklemek veya bilgisayarınızdaki yardım dosyalarını güncelleştirmek için cmdlet'ini Update-Help kullanın.

Cmdlet Update-Help , aşağıdaki görevler de dahil olmak üzere tüm zor işleri sizin için yapar.

  • Hangi modüllerin Güncelleştirilebilir Yardım'ın destekleneceğini belirler.
  • Her modülün Güncelleştirilebilir Yardım dosyalarını depoladığı İnternet konumunu bulur.
  • Bilgisayarınızdaki her modülün yardım dosyalarını, her modül için kullanılabilen en yeni yardım dosyalarıyla karşılaştırır.
  • Yeni dosyaları internetten indirir.
  • Yardım dosyası paketinin işaretini kaldırın.
  • Dosyaların geçerli yardım dosyaları olduğunu doğrular.
  • Yardım dosyalarını modül dizininin dile özgü alt dizinine yükler.

Yeni yardım konularına erişmek için cmdlet'ini Get-Help kullanın. PowerShell'i yeniden başlatmanız gerekmez.

Güncelleştirilebilir Yardım'ı destekleyen bilgisayardaki tüm modüllerin yardımını yüklemek veya güncelleştirmek için şunu yazın:

Update-Help

Belirli modüllerle ilgili yardımı güncelleştirmek için modül parametresini Update-Helpekleyin. Modül adında joker karakterlere izin verilir.

Örneğin, ServerManager modülüne yönelik yardımı güncelleştirmek için şunu yazın:

Update-Help -Module ServerManager

Parametreler olmadan güncelleştirmeler, Update-Help oturumdaki tüm modüller ve Güncelleştirilebilir Yardım'ı destekleyen tüm yüklü modüller için yardımcı olur. Modüllerin dahil edilmesi için PSModulePath ortam değişkeninin değerinde listelenen dizinlere yüklenmesi gerekir. Bunlar ayrıca bir Get-Module -ListAvailable komut tarafından döndürülen modüllerdir.

Module parametresinin * değeri (tümü) Update-Help ise Güncelleştirilebilir Yardım'ı desteklemeyen modüller de dahil olmak üzere tüm yüklü modüller için yardımı güncelleştirmeye çalışır. Bu komut genellikle cmdlet Güncelleştirilebilir Yardım'ın destekleilmeyen modüllerle karşılaştığında birçok hata oluşturur.

Dosya paylaşımından yardım güncelleştirme

İnternet'e bağlı olmayan bilgisayarları desteklemek veya bir kuruluşta güncelleştirme işlemini denetlemek veya kolaylaştırmak için cmdlet'ini Save-Help kullanın. Save-Help Cmdlet, yardım dosyalarını İnternet'ten indirir ve belirttiğiniz bir dosya sistemi dizinine kaydeder.

Save-Help belirtilen dizindeki yardım dosyalarını her modül için kullanılabilen en yeni yardım dosyalarıyla karşılaştırır. Dizinde yardım dosyası yoksa veya modül için daha yeni yardım dosyaları varsa, Save-Help cmdlet yeni dosyaları İnternet'ten indirir. Ancak, yardım dosyalarını kaldırmaz veya yüklemez.

Bir dosya sistemi dizinine kaydedilmiş yardım dosyalarından bir bilgisayara yardım dosyalarını yüklemek veya güncelleştirmek için cmdlet'in Update-Help SourcePath parametresini kullanın. Update-Help Cmdlet en yeni yardım dosyalarını tanımlar, bunları açıp doğrular ve modül dizinlerinin dile özgü alt dizinlerine yükler.

Örneğin, tüm yüklü modüllerin yardımını \\Server\Share dizine kaydetmek için şunu yazın:

Save-Help -DestinationPath \\Server\Share

Ardından, dizinindeki \\Server\Share yardımı güncelleştirmek için şunu yazın:

Update-Help -SourcePath \\Server\Share

Aşağıdaki örneklerde, yerel bilgisayarda yüklü olmayan modüller için yardım kaydetmek için komutunun kullanımı Save-Help gösterilmektedir. Bu örnekte yönetici, DhcpServer modülünü veya DHCP Sunucusu rolünü yerel bilgisayara yüklemeden İnternet'e bağlı bir istemci bilgisayardan DhcpServer modülüne yönelik yardımı kaydetmek için çalışır Save-Help .

Seçenek 1: Uzak modülün PSModuleInfo nesnesini almak için komutunu çalıştırınInvoke-Command, bir değişkene $mkaydedin ve ardından değişkeni $m modül adı olarak belirterek PSModuleInfo nesnesinde çalıştırınSave-Help.

$invokeCommandSplat = @{
    ComputerName = 'RemoteServer'
    ScriptBlock = { Get-Module -Name DhcpServer -ListAvailable }
}
$m = Invoke-Command @invokeCommandSplat
Save-Help -Module $m -DestinationPath C:\SavedHelp

Seçenek 2: DHCP Sunucusu modülünü çalıştıran bilgisayara hedeflenen bir PSSession açın, modülün PSModuleInfo nesnesini alın, bir değişkene $mkaydedin ve değişkene $m kaydedilen nesnede çalıştırınSave-Help.

$s = New-PSSession -ComputerName RemoteServer
$m = Get-Module -PSSession $s -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

Seçenek 3: MODÜLÜn PSModuleInfo nesnesini almak için DHCP Sunucusu modülünü çalıştıran bilgisayarda hedeflenen bir CIM oturumu açın, bunu bir değişkene $mkaydedin ve ardından değişkene $m kaydedilen nesne üzerinde çalıştırınSave-Help.

$c = New-CimSession -ComputerName RemoteServer
$m = Get-Module -CimSession $c -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp

Aşağıdaki örnekte, yönetici dhcp sunucusu modülü için yardımını ağ erişimi olmayan bir bilgisayara yükler.

İlk olarak, PSModuleInfo nesnesini paylaşılan bir klasöre veya çıkarılabilir medyaya aktarmak için komutunu çalıştırınExport-Clixml.

$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbDrive\DhcpModule.xml -InputObject $m

Ardından, çıkarılabilir medyayı İnternet erişimi olan bir bilgisayara aktarın ve ardından ile Import-ClixmlPSModuleInfo nesnesini içeri aktarın. İçeri aktarılan DHCPServer modülü PSModuleInfo nesnesi için Yardım'ı kaydetmek için komutunu çalıştırınSave-Help.

$deserialized_m = Import-Clixml E:\UsbDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath E:\UsbDrive\SavedHelp

Son olarak, çıkarılabilir medyayı ağ erişimi olmayan bilgisayara geri aktarın ve komutunu çalıştırarak Update-Helpyardımı yükleyin.

Update-Help -Module DhcpServer -SourcePath E:\UsbDrive\SavedHelp

Parametreler olmadan indirmeler, Save-Help oturumdaki tüm modüller ve Güncelleştirilebilir Yardım'ı destekleyen tüm yüklü modüller için yardım alır. Dahil olmak için modüllerin, yerel bilgisayarda veya yardım kaydetmek istediğiniz uzak bilgisayarda ortam değişkeninin $env:PSModulePath değerinde listelenen dizinlere yüklenmesi gerekir. Bunlar ayrıca bir Get-Help -ListAvailable komut çalıştırılarak döndürülen modüllerdir.

Farklı dillerde yardım dosyalarını güncelleştirme

Varsayılan olarak, Update-Help ve Save-Help cmdlet'leri yerel bilgisayarda Windows için ayarlanan kullanıcı arabirimi kültürü ve dilinde yardım indirir. Belirtilen modüller için yardım dosyaları yerel kullanıcı arabirimi kültüründe Update-Help kullanılamıyorsa ve Save-Help desteklenen en iyi dili bulmak için Windows dili geri dönüş kurallarını kullanın.

Ancak, ve Save-Help cmdlet'lerinin Update-Help UICulture parametrelerini kullanarak yardım dosyalarını kullanılabilir oldukları tüm ui kültürlerine indirip yükleyebilirsiniz.

Örneğin, oturumdaki tüm modüller için en yeni yardım dosyalarını Japonca (ja-Jp) ve Fransızca (fr-FR) olarak kaydetmek için şunu yazın:

Save-Help -Path \Server\Share -UICulture ja-jp, fr-fr

Modüllerin yardım dosyaları belirttiğiniz dillerde kullanılamıyorsa ve Save-Help cmdlet'leri, Update-Help gereksinimlerinize en uygun alternatifi seçebilmeniz için her modül için yardımın kullanılabildiği dilleri listeleyen bir hata iletisi döndürür.

Not

Şu anda Güncelleştirilebilir Yardım içeriği yalnızca İngilizce (en-US) olarak yayımlanmaktadır.

Çevrimiçi yardımı kullanma

Yerel bilgisayarınızdaki yardım dosyalarını güncelleştiremiyor veya güncelleştirmemeyi seçemiyorsanız, en yeni yardım dosyalarını yine de çevrimiçi alabilirsiniz.

Herhangi bir cmdlet veya işlev için çevrimiçi yardım konusunu açmak için cmdlet'in Çevrimiçi parametresini Get-Help kullanın.

Örneğin, aşağıdaki komut cmdlet'in Get-Job çevrimiçi yardım konusunu varsayılan internet tarayıcınızda açar:

Get-Help Get-Job -Online

Bir betik için çevrimiçi yardım almak için Çevrimiçi parametresini ve betiğin tam yolunu kullanın.

Çevrimiçi parametresi Hakkında konularıyla çalışmaz. PowerShell diliyle ilgili yardım konuları da dahil olmak üzere PowerShell ile ilgili konuları görmek için bkz . PowerShell Konular Hakkında.

İnternet indirmelerini en aza indirme veya önleme

İnternet indirmelerini en aza indirmek ve İnternet'e bağlı olmayan kullanıcılara Güncelleştirilebilir Yardım sağlamak için cmdlet'ini Save-Help kullanın. İnternet'ten yardım indirin ve bir ağ paylaşımına kaydedin. Ardından, tüm bilgisayarlarda bir Update-Help komut çalıştıran bir Grup İlkesi ayarı veya zamanlanmış iş oluşturun. Cmdlet'in SourcePath parametresinin Update-Help değerini ağ paylaşımına ayarlayın.

İnternet erişimi olan kullanıcıların Güncelleştirilebilir Yardım'ı internetten indirmesini önlemek için Güncelleştirme-Yardım Grup İlkesi için varsayılan kaynak yolu ayarla ayarını kullanın.

Bu Grup İlkesi ayarı, kaynak yolu parametresini belirttiğiniz dosya sistemi konumuyla birlikte etkilenen her bilgisayardaki tüm Update-Help komutlara örtük olarak ekler. Kullanıcılar SourcePath parametresini açıkça kullanarak farklı bir dosya sistemi konumu belirtebilir, ancak SourcePath parametresini dışlayamaz ve internetten yardım indiremezler.

Not

Güncelleştirme-Yardım grup ilkesi için varsayılan kaynak yolu ayarla ayarı, Bilgisayar Yapılandırması ve Kullanıcı Yapılandırması altında görünür. Ancak, yalnızca Bilgisayar Yapılandırması altındaki ilke ayarı etkilidir. Kullanıcı Yapılandırması altındaki ilke ayarı yoksayılır.

Daha fazla bilgi için, bkz. about_Group_Policy_Settings.

Standart olmayan modüller için yardım güncelleştirme

Cmdlet'in ListAvailable parametresi tarafından döndürülmeyen Get-Module bir modülü güncelleştirmek veya kaydetmek için, veya Update-HelpSave-Help komutunu çalıştırmadan önce modülü geçerli oturuma aktarın. Uzak bir bilgisayarda, komutu çalıştırmadan Save-Help önce modülü uzak bilgisayara bağlı olan geçerli Oturuma veya Invoke-Command betik bloğuna aktarın.

Modül geçerli oturumdayken veya Save-Help cmdlet'lerini parametresiz çalıştırın Update-Help veya modül adını belirtmek için Module parametresini kullanın.

ve Save-Help cmdlet'lerinin Update-HelpModül parametreleri yalnızca bir modül adını kabul eder. Modül dosyasının yolunu kabul etmedikleri için.

Ortam değişkeninde listelenmeyen bir konuma yüklenmiş bir modül veya iyi biçimlendirilmemiş bir modül gibi cmdlet'in ListAvailable parametresi Get-Module tarafından döndürülmeyen modüller $env:PSModulePath için yardım güncelleştirmek veya kaydetmek için bu tekniği kullanın (modül dizini, temel adı dizin adıyla aynı olan en az bir dosya içermez).

Güncelleştirilebilir yardımı destekleme

Bir modül yazarsanız, modülleriniz için çevrimiçi yardım ve Güncelleştirilebilir Yardım'ı destekleyebilirsiniz. Daha fazla bilgi için bkz . Güncelleştirilebilir Yardımı Destekleme ve Çevrimiçi Yardımı Destekleme.

PowerShell ek bileşenleri veya açıklama tabanlı yardım için güncelleştirilebilir yardım kullanılamaz.

Açıklamalar

Update-Help ve Save-Help cmdlet'leri Windows Önyükleme Ortamı'nda (Windows PE) desteklenmez.

Ayrıca bkz.