Hakkında_Güncellenebilir_Yardım

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 up-togü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, Windows PowerShell uzaktan iletişim sırasında HelpInfoUri özelliği korunarak, Save-Help'nin uzak bir bilgisayara yüklü olan ancak yerel bilgisayarda yüklü olmayan modüller için çalışmasına olanak tanır. PSModuleInfo nesnesini İnternet erişimi olmayan bir bilgisayarda Export-Clixml çalıştırarak, internet erişimi olmayan bir bilgisayarda PSModuleInfo nesnesini içeri aktararak ve ardından Save-Help nesnesinde çalıştırarak diske veya çıkarılabilir medyaya (USB sürücüsü gibi) kaydedebilirsiniz. Kaydedilen yardım çıkarılabilir medya kullanılarak uzak, bağlantısı kesilmiş bilgisayara kopyalanabilir ve ardından Update-Helpçalıştırılarak yüklenebilir. Save-Help işlevselliğindeki bu geliştirmeler, herhangi bir ağ erişimi olmayan bilgisayarlara yardım yüklemenize olanak tanır. Yeni Save-Help işlevselliğinin nasıl kullanılacağına ilişkin bir örnek için bu konudaki dosya paylaşımından yardımın nasıl güncelleştirileceğine 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 Update-Helpkullanın.

• 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'i 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 Get-Culture cmdlet'i için temel yardım alır. Çıktı, bilgisayarda yardım dosyası olmadığında Get-Help görüntüsünü gösterir.

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, Set-ExecutionPolicy cmdlet'ini içeren 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

$PSHOME/Modulesdizinindeki modüllerin yardımını güncelleştirmek için bilgisayardaki Administrators grubunun üyesi olmanız gerekir.

Yöneticiler grubunun üyesi değilseniz, bu modüller için yardımı güncelleştiremezsiniz; ancak İnternet erişiminiz varsa çevrimiçi yardım görüntüleyebilirsiniz.

Dizin $HOME/Documents/PowerShell/Modules modülleri veya $HOME dizininin diğer alt dizinlerindeki modüller için yardım güncelleştirilmesi özel izinler gerektirmez.

Update-Help ve Save-Help cmdlet'leri, 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.

Update-Help ve Save-Help cmdlet'leri, komutu uzak bir bilgisayarda çalıştırmanıza ve üçüncü bir bilgisayardaki dosya paylaşımına erişmenize olanak tanıyan bir Kimlik Bilgisi parametresine de sahiptir. Kimlik Bilgisi parametresi yalnızca SourcePath veya Update-Help parametrelerini ve DestinationPath veya Save-Help parametrelerini kullandığı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 Update-Help cmdlet'ini kullanın.

Update-Help cmdlet'i, 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ı paketini açar.
• 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 Get-Help cmdlet'ini 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üncellemek için parametresi olarak Update-Help'i ekleyin. 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 Update-Help, oturumdaki tüm modüller ve Güncelleştirilebilir Yardım'ı destekleyen tüm yüklü modüller için yardımı günceller. 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 komutu tarafından döndürülen modüllerdir.

Modülü parametresinin değeri * (tümü) ise Update-Help 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, cmdlet'in Güncellenebilir Yardım'ı desteklemeyen modüllerle karşılaşması nedeniyle genellikle birçok hata üretir.

Dosya paylaşımından nasıl yardım güncellenir

İnternet'e bağlı olmayan bilgisayarları desteklemek veya bir kuruluşta güncelleştirme işlemini denetlemek veya kolaylaştırmak için Save-Help cmdlet'ini kullanın. Save-Help cmdlet'i, internetten yardım dosyalarını indirir ve bunları 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'i 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 parametresini kullanın. Update-Help cmdlet'i 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 dizinine kaydetmek için şunu yazın:

Save-Help -DestinationPath \\Server\Share

Ardından, \\Server\Share dizininden 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 üzere Save-Help kullanımı 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 Save-Help çalıştırır.

1. Seçenek: Uzak modülün Invoke-Command nesnesini almak için çalıştırın, bir değişkene kaydedin, $mve ardından modül adı olarak değişken Save-Help belirterek PSModuleInfo nesnesinde $m çalıştırın.

$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 ve bunu $mdeğişkenine kaydedin. Ardından, Save-Help değişkenine kaydedilen nesnede $m çalıştırın.

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

Seçenek 3: DHCP Sunucusu modülünü çalıştıran bilgisayarı hedefleyerek bir CIM oturumu açın. Modülün PSModuleInfo nesnesini alın ve bunu $mbir değişkene kaydedin. Ardından, Save-Help değişkenine kaydedilen nesne üzerinde $m çalıştırın.

$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, Export-Clixml nesnesini paylaşılan klasöre veya çıkarılabilir medyaya aktarmak için çalıştırın.

$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-Clixml nesnesini içeri aktarın. PSModuleInfo Save-Help içeri aktarılan DhcpServer modülü için Yardım'ı kaydetmek için çalıştırın.

$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 ardından Update-Helpkomutunu çalıştırarak yardımı yükleyin.

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

Parametreler olmadan Save-Help, oturumdaki tüm modüller ve Güncelleştirilebilir Yardım'ı destekleyen tüm yüklü modüller için yardımı indirir. Dahil olmak için modüllerin, $Env:PSModulePath ortam değişkeninin değerinde listelenen dizinlere, yerel bilgisayara veya yardım kaydetmek istediğiniz uzak bir bilgisayara yüklenmesi gerekir. Bunlar ayrıca bir Get-Help -ListAvailable komutu ç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 dosyalarını indirir. Belirtilen modüllerin yardım dosyaları yerel kullanıcı arabirimi kültüründe kullanılamıyorsa, Update-Help ve Save-Help desteklenen en iyi dili bulmak için Windows dili geri dönüş kurallarını kullanın.

Ancak, ve Update-Help cmdlet'lerinin Save-Help 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, Update-Help ve Save-Help cmdlet'leri, 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 Get-Help parametresini kullanın.

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

Get-Help Get-Job -Online

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

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

İ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 Save-Help cmdlet'ini kullanın. İnternet'ten yardım indirin ve bir ağ paylaşımına kaydedin. Ardından, tüm bilgisayarlarda bir Update-Help komutu çalıştıran bir Grup İlkesi ayarı veya zamanlanmış iş oluşturun. cmdlet'in Update-Help parametresinin 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 yolunu ayarla kullanın.

Bu Grup İlkesi ayarı, belirttiğiniz dosya sistemi konumuyla SourcePath parametresini etkilenen her bilgisayardaki her Update-Help komutuna örtük olarak ekler. Kullanıcılar farklı bir dosya sistemi konumu belirtmek için SourcePath parametresini açıkça kullanabilir, ancak SourcePath parametresini dışlayamaz ve internetten yardım indiremezler.

Not

"Update-Help" grup ilkesi için varsayılan kaynak yolu ayarı, Bilgisayar Yapılandırması altında ve Kullanıcı Yapılandırmasıolarak görünür. Ancak, yalnızca Bilgisayar Yapılandırması altındaki ilke ayarı geçerlidir. 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ı nasıl güncelleştireceğiniz

cmdlet'in Get-Module parametresi tarafından döndürülmeyen bir modülü güncelleştirmek veya kaydetmek için, bir Update-Help veya Save-Help komutu ç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ı geçerli Oturuma veya Invoke-Command betik bloğuna aktarın.

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

ModülüUpdate-Help ve Save-Help cmdlet'lerinin parametreleri yalnızca modül adını kabul eder. Modül dosyasının yolunu kabul etmiyorlar.

cmdlet'inin Get-Module parametresi tarafından döndürülmeyen herhangi bir modülü güncelleştirmek veya kaydetmek için bu tekniği kullanın; örneğin, $Env:PSModulePath ortam değişkeninde listelenmeyen bir konuma yüklenmiş bir modül veya iyi biçimlendirilmemiş bir modül (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. Destek Güncelleştirilebilir Yardım ve Destek Çevrimiçi Yardım.

PowerShell eklentileri veya yorum tabanlı yardım için güncellenebilir yardım kullanılamaz.

Açıklamalar

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

Ayrıca bkz.

• Yardım Alma
• Yardım Kaydet
• Güncelleştirme-Yardım