Kullanım
hiutil -I BİÇİM -Cf dosya [-1agv] [-m SAYI] [-s DİL | YOL] [-r URL] [-t UZANTI] dizin
hiutil [-ADEFMST] -f dosya
Açıklama
hiutil, Latent Semantic Mapping (LSM) yardım biçimindeki .helpindex dosyalarını ve Spotlight yardım biçimindeki .cshelpindex dosyalarını oluşturmak için kullanılır. Ayrıca aşağıda listelenen modları kullanarak Spotlight yardım dizinlerini inceleyebilir. LSM dizinlerini incelemek için hiutil'in 2.0'dan önceki bir sürümünü kullanın.
Spotlight yardım dizinleri, macOS Mojave veya sonraki sürümlerde gereklidir. Spotlight dizinleri, macOS Mojave'den önceki sürümlerle uyumlu değildir.
macOS yardım sistemi, yerel yardım kitapları için dizinleri otomatik olarak oluşturur (bkz. ~/Library/Caches/com.apple.helpd/). Eğer yardım içeriğiniz uzaktan barındırılacaksa, uzaktaki yardım kitabınıza dahil etmek üzere manuel olarak bir dizin oluşturmak isteyebilirsiniz.
Oluşturma, yönetme, inceleme ve bilgi modları doğrudan aşağıda listelenmiştir.
Oluşturma ve yönetme modları:
-C, --create Belirttiğiniz konumda bir dizin dosyası oluşturur. Hem dizine eklenecek HTML dosyalarının bulunduğu bir dizini hem de çıktı dosyasının yolunu belirtmeniz gerekir; çıktı dosyası zaten mevcutsa üzerine yazılacaktır.
-I, --index-format Dizin biçimi türünü 'lsm' veya 'corespotlight' olarak belirtin.
-P, --purge-caches Eğer çalışıyorlarsa Help Viewer ve helpd süreçlerini sonlandırır ve kalıcı Help Viewer ile ilgili önbellekleri temizler.
İnceleme ve bilgi modları:
-A, --list-anchors Dizindeki çapaları (anchors) yeni satırlarla ayrılmış olarak listeler.
-D, --list-anchor-dictionary Dizindeki çapa sözlüğünü XML biçiminde listeler. Bu, her bir çapanın hangi dosyalarda bulunduğunun listesini içerir.
-E, --list-index-versions Dizinin sürüm sözlüğünü XML biçiminde listeler. Dizinin oluşturulduğu sistem ortamını açıklar.
-F, --list-files Dizine dahil edilen tüm dosyaları yeni satırlarla ayrılmış olarak listeler. Başlıkları ve açıklamaları da almak için bu modla birlikte -v seçeneğini kullanabilirsiniz.
-H, --help Kullanım verilerini yazdırır.
-M, --list-min-term-length Dizinin minimum terim uzunluğunu listeler.
-S, --list-stopwords Dizindeki durdurma sözcüklerini (stopwords) yeni satırlarla ayrılmış olarak listeler.
-T, --list-terms Her bir dosyada dizine eklenen terimleri listeler.
-V, --version Aracın sürümünü yazdırır.
Genel Seçenekler
Bunlar herhangi bir modla birlikte kullanılabilir.
-f, --file Oluşturulacak ya da incelenecek bir dosyanın yolunu belirtir.
-v, --verbose Ayrıntılı çıktı belirtir. Hatalar her zaman gösterilir, ancak bu argümanın bir kez geçilmesi uyarıları da yazdırır. Argümanın iki kez geçilmesi hataları, uyarıları ve ilerleme notlarını yazdırır.
Oluşturma Seçenekleri
Bunlar yalnızca oluşturma (create) moduyla kullanılabilir.
-1: Her seferinde tek bir dosyayı dizine ekler. Varsayılan davranış, paralel olarak birkaç dosyayı dizine eklemek için bir kuyruk kullanmaktır. -vvv ile birlikte kullanıldığında bu seçenek, bir hata mesajının hangi dosyadan kaynaklandığını belirlemede yararlı olabilir.
-a, --anchors Dizin çapalarını belirtir. Varsayılan olarak hiç çapa belirtilmez. Bu bayrak olmadan, dizinde çapa sözlüğü bulunmayacaktır.
-e, --exclude=ÖRÜNTÜ Belirtilen örüntüyle eşleşen dosyaları hariç tutar. Dizine eklenen dizine göre dosyanın göreli yolu üzerinde NSPredicate'in MATCHES karşılaştırma yöntemini kullanır. Bu seçenek, örüntü başına bir kez olmak üzere gerektiği kadar çok kez geçilebilir. Hariç tutmalar, -i ile dahil edilen dosyalara göre önceliklidir.
-g, --generate-summaries Özet metin oluşturur. Bu işlem yavaş olabilir, ancak bazı sayfalarda DESCRIPTION meta etiketleriniz yoksa kullanışlıdır.
-i, --include=ÖRÜNTÜ Belirtilen örüntüyle eşleşen dosyaları dahil eder. Dizine eklenen dizine göre dosyanın göreli yolu üzerinde NSPredicate'in MATCHES karşılaştırma yöntemini kullanır. Dizine eklenecek varsayılan örüntüler ".htm" ve ".html"dir. Bu varsayılanlar istenmiyorsa, bunları hariç tutmak için yukarıdaki -e seçeneğini kullanabilirsiniz. Bu seçenek, örüntü başına bir kez olmak üzere gerektiği kadar çok kez geçilebilir.
-m, --min-term-length=SAYI Minimum terim uzunluğunu belirtir. Değer 1, 2 veya 3 olabilir. Bir terimin dizin oluşturucu tarafından göz ardı edilmemesi için gereken ardışık simgelerin (genellikle bir karakter) sayısını temsil eder. Önerilen değerler İngilizce için 3, Çince ve diğer ideografik diller için 1'dir.
-r, --remote-url=URL Dizinle birlikte uzak bir URL dahil eder. Bu seçenek yalnızca Tip 1 veya Tip 2 yardım kitaplarında kullanışlıdır, çünkü Tip 3 kitaplarda URL yardım paketinin Info.plist dosyası içindedir. URL tam nitelikli olmalıdır. Örneğin:
https://www.mycompany.com/help_v1/
-s, --stopwords=DİL|YOL Durdurma sözcüklerini (stopwords) kullanır. Kendinize ait bir durdurma sözcükleri .plist dosyanız varsa, bu yolu belirtin. Aksi takdirde, iki karakterli dil kodunu geçirin. Örneğin:
en İngilizce es İspanyolca de Almanca fr Fransızca hu Macarca it İtalyanca sv İsveççe
-l, --locale=DİL Dizin için bir yerel ayar (locale) belirtir. Dizine ekleme yapmak için sisteminizi ilgili yerel ayarda başlatmak yerine, o dil için dizin oluşturmak üzere dil kodunu veya yerel ayar tanıtıcısını buraya geçirin. Örnek yerel ayar tanıtıcıları:
en_US Amerikan İngilizcesi es_ES İspanyolca de Almanca fr Fransızca hu Macarca ru_RU Rusça
Dosyalar
/usr/share/hiutil/Stopwords.plist
Farklı dillerdeki varsayılan durdurma sözcüklerinin listesi
Örnekler
HTML yardımı içeren bir dizinden .cshelpindex dosyası oluşturma:
hiutil -I corespotlight -Caf /pathto/myhelp.cshelpindex /pathto/myhelpdir/
Bir .cshelpindex dosyasındaki çapaları inceleme:
hiutil -I corespotlight -Af /pathto/myhelp.cshelpindex
Bir .cshelpindex dosyasındaki terimleri ayrıntılı olarak inceleme:
hiutil -I corespotlight -Tvf /pathto/myhelp.cshelpindex
Notlar
hiutil için macOS 10.14 veya daha yenisi gereklidir.
Darwin 05/22/2019 Darwin