argp_help İşlevi

Normalde argp arayüzünü kullanan yazılımlarda argüman kullanım iletilerinin basılması için, bu işlem argp tarafından standart --help seçeneği ile özdevinimli olarak yapıldığından, ayrıca kod yazılması gerekmez. Hata durumlarında ise argp_usage ve argp_error kullanılır. Bkz. Argp Çözümleyicilere Yardımcı İşlevler. Ancak, bir yardım iletisinde yazılımın seçenek çözümlemesi dışında bazı bilgilerin basılması istenebilir. Argp arayüzü bu tür istekleri karşılamak üzere argp_help arayüzünü içerir.

void argp_help

(const struct argp *argp,
 FILE              *akım,
 unsigned           bayraklar,
 char              *isim)

işlev

argp çözümleyici için bir yardım iletisini akım akımına çıktılar. Basılacak iletinin türü bayraklar ile belirtilir.

Argp arayüzü tarafından --help gibi özdevinimli gerçeklenen seçeneklere ilişkin yardım çıktısı bu çıktıda yer almaz. Bu nedenle çağrıyı bir argp çözümleyici işlev içinden yapıyorsanız en iyisi argp_state_help işlevini kullanmaktır. Bkz. Argp Çözümleyicilere Yardımcı İşlevler.