getopt - Dalam talian di Awan

JADUAL:

NAMA

getopt - parse pilihan arahan (dipertingkatkan)

SINOPSIS

getopt optstring parameter
getopt [pilihan] [--] optstring parameter
getopt [pilihan] -o|--pilihan optstring [pilihan] [--] parameter

DESCRIPTION

getopt digunakan untuk berpisah (menghurai) pilihan dalam baris arahan untuk penghuraian mudah oleh shell
prosedur, dan untuk menyemak pilihan undang-undang. Ia menggunakan GNU getopt(3) rutin yang perlu dilakukan
ini.

Parameternya getopt dipanggil dengan boleh dibahagikan kepada dua bahagian: pilihan yang mengubah suai
jalan getopt akan melakukan penghuraian (the pilihan dan juga optstring dalam SINOPSIS), Dan
parameter yang akan dihuraikan (parameter dalam SINOPSIS). Bahagian kedua akan
mulakan pada parameter bukan pilihan pertama yang bukan hujah pilihan, atau selepas yang pertama
kejadian '--'. Jika tidak '-o'atau'--pilihan' pilihan terdapat di bahagian pertama, iaitu
parameter pertama bahagian kedua digunakan sebagai rentetan pilihan pendek.

Jika pembolehubah persekitaran GETOPT_COMPATIBLE ditetapkan, atau jika yang pertama parameter bukan satu
pilihan (tidak bermula dengan '-', format pertama dalam SINOPSIS), getopt akan menjana
output yang serasi dengan versi lain getopt(1). Ia masih akan berjaya
merombak parameter dan mengenali argumen pilihan (lihat bahagian KOMPATIBILITAS selama lebih
maklumat).

Pelaksanaan tradisional bagi getopt(1) tidak dapat mengatasi ruang kosong dan lain-lain
(khusus shell) aksara khas dalam argumen dan parameter bukan pilihan. Untuk menyelesaikan ini
masalah, pelaksanaan ini boleh menjana keluaran sebut harga yang mesti sekali lagi
ditafsirkan oleh shell (biasanya dengan menggunakan menipu perintah). Ini mempunyai kesan
memelihara watak-watak itu, tetapi anda mesti memanggil getopt dengan cara yang tidak lagi
serasi dengan versi lain (format kedua atau ketiga dalam SINOPSIS). Untuk menentukan
sama ada versi dipertingkatkan ini getopt(1) dipasang, pilihan ujian khas (-T) boleh jadi
terpakai.

PILIHAN

-a, --alternatif
Benarkan pilihan panjang bermula dengan satu '-'.

-h, - membantu
Paparkan teks bantuan dan keluar. Tiada output lain dihasilkan.

-l, --pilihan panjang longopts
Pilihan panjang (berbilang aksara) untuk diiktiraf. Lebih daripada satu nama pilihan boleh
dinyatakan sekali gus, dengan mengasingkan nama dengan koma. Pilihan ini mungkin
diberikan lebih daripada sekali, iaitu longopts adalah kumulatif. Setiap nama pilihan panjang dalam
longopts boleh diikuti oleh satu titik bertindih untuk menunjukkan ia mempunyai hujah yang diperlukan, dan
dengan dua titik bertindih untuk menunjukkan ia mempunyai hujah pilihan.

-n, --nama progname
Nama yang akan digunakan oleh getopt(3) rutin apabila ia melaporkan ralat. Catatan
bahawa kesilapan daripada getopt(1) masih dilaporkan datang dari getopt.

-o, --pilihan pintasan
Pilihan pendek (satu aksara) untuk diiktiraf. Jika pilihan ini tidak ditemui,
parameter pertama bagi getopt itu tidak bermula dengan '-' (dan bukan pilihan
argumen) digunakan sebagai rentetan pilihan pendek. Setiap aksara pilihan pendek dalam
pintasan boleh diikuti oleh satu titik bertindih untuk menunjukkan ia mempunyai hujah yang diperlukan, dan
dengan dua titik bertindih untuk menunjukkan ia mempunyai hujah pilihan. Watak pertama
pintasan mungkin '+'atau'-' untuk mempengaruhi cara pilihan dihuraikan dan output
dihasilkan (lihat bahagian PEMARKAHAN MODUL untuk maklumat lanjut).

-q, --senyap
Lumpuhkan pelaporan ralat oleh getopt(3).

-Q, --output senyap
Jangan jana output biasa. Ralat masih dilaporkan oleh getopt(3), melainkan anda
juga gunakan -q.

-s, - cengkaman shell
Tetapkan konvensyen petikan kepada konvensyen shell. Jika -s pilihan tidak diberikan, BASH
konvensyen digunakan. Hujah yang sah pada masa ini adalah 'sh''menampar','csh', dan
'tcsh'.

-T, --ujian
Uji jika anda getopt(1) adakah versi dipertingkatkan ini atau versi lama. Ini menjana
tiada keluaran, dan menetapkan status ralat kepada 4. Pelaksanaan lain bagi getopt(1), dan
versi ini jika pembolehubah persekitaran GETOPT_COMPATIBLE ditetapkan, akan kembali '--'
dan status ralat 0.

-u, --tidak disebut
Jangan petik output. Ambil perhatian bahawa ruang putih dan khas (bergantung pada cangkang)
aksara boleh menyebabkan malapetaka dalam mod ini (seperti yang mereka lakukan dengan yang lain getopt(1)
pelaksanaan).

-V, --versi
Paparkan maklumat versi dan keluar. Tiada output lain dihasilkan.

PARSING

Bahagian ini menentukan format bahagian kedua parameter bagi getopt (Yang
parameter dalam SINOPSIS). Bahagian seterusnya (OUTPUT) menerangkan output iaitu
dihasilkan. Parameter ini biasanya merupakan parameter yang dipanggil fungsi shell
dengan. Penjagaan mesti diambil bahawa setiap parameter fungsi shell dipanggil
sepadan dengan tepat satu parameter dalam senarai parameter getopt (Lihat CONTOH).
Semua penghuraian dilakukan oleh GNU getopt(3) rutin.

Parameter dihuraikan dari kiri ke kanan. Setiap parameter dikelaskan sebagai pendek
pilihan, pilihan panjang, hujah kepada pilihan, atau parameter bukan pilihan.

Pilihan ringkas yang mudah ialah '-' diikuti dengan watak pilihan pendek. Jika pilihan mempunyai a
hujah yang diperlukan, ia boleh ditulis terus selepas aksara pilihan atau sebagai seterusnya
parameter (iaitu dipisahkan oleh ruang putih pada baris arahan). Jika pilihan mempunyai
hujah pilihan, ia mesti ditulis terus selepas aksara pilihan jika ada.

Adalah mungkin untuk menentukan beberapa pilihan pendek selepas satu '-', asalkan semua (kecuali
mungkin yang terakhir) tidak mempunyai hujah yang diperlukan atau pilihan.

Pilihan yang panjang biasanya bermula dengan '--' diikuti dengan nama pilihan panjang. Jika pilihan
mempunyai hujah yang diperlukan, ia boleh ditulis terus selepas nama pilihan panjang, dipisahkan
oleh '=', atau sebagai hujah seterusnya (iaitu dipisahkan oleh ruang putih pada baris arahan). Jika
pilihan mempunyai hujah pilihan, ia mesti ditulis terus selepas pilihan panjang
nama, dipisahkan dengan '=', jika ada (jika anda menambah '=' tetapi tiada apa di belakangnya, ia adalah
ditafsirkan seolah-olah tiada hujah yang hadir; ini adalah pepijat kecil, lihat BUANG). Panjang
pilihan boleh dipendekkan, selagi singkatan itu tidak samar-samar.

Setiap parameter tidak bermula dengan '-', dan bukan hujah yang diperlukan untuk pilihan sebelumnya,
ialah parameter bukan pilihan. Setiap parameter selepas '--' parameter sentiasa ditafsirkan sebagai
parameter bukan pilihan. Jika pembolehubah persekitaran POSIXLY_BETUL ditetapkan, atau jika
rentetan pilihan pendek dimulakan dengan '+', semua parameter yang tinggal ditafsirkan sebagai
parameter bukan pilihan sebaik sahaja parameter bukan pilihan pertama ditemui.

OUTPUT

Output dijana untuk setiap elemen yang diterangkan dalam bahagian sebelumnya. Output dilakukan dalam
susunan yang sama seperti elemen yang dinyatakan dalam input, kecuali untuk bukan pilihan
parameter. Output boleh dilakukan dalam serasi (tidak dipetik) mod, atau dengan cara sedemikian
ruang putih dan aksara khas lain dalam argumen dan parameter bukan pilihan ialah
dipelihara (lihat SEBUTHARGA). Apabila output diproses dalam skrip shell, ia akan kelihatan
untuk terdiri daripada elemen yang berbeza yang boleh diproses satu demi satu (dengan menggunakan shift
arahan dalam kebanyakan bahasa shell). Ini tidak sempurna dalam mod tidak disebut, kerana unsur boleh jadi
berpecah di tempat yang tidak dijangka jika ia mengandungi ruang putih atau aksara khas.

Jika terdapat masalah menghuraikan parameter, contohnya kerana hujah yang diperlukan ialah
tidak dijumpai atau pilihan tidak dikenali, ralat akan dilaporkan pada stderr, akan ada
tiada keluaran untuk elemen yang menyinggung perasaan, dan status ralat bukan sifar dikembalikan.

Untuk pilihan pendek, satu '-' dan watak pilihan dijana sebagai satu parameter.
Jika pilihan mempunyai hujah, parameter seterusnya ialah hujah. Jika pilihan
mengambil hujah pilihan, tetapi tiada yang ditemui, parameter seterusnya akan dijana tetapi
kosong dalam mod petikan, tetapi tiada parameter kedua akan dijana dalam tidak disebut
mod (serasi). Perhatikan bahawa banyak lagi getopt(1) pelaksanaan tidak menyokong pilihan
hujah-hujah.

Jika beberapa pilihan pendek ditentukan selepas satu '-', masing-masing akan hadir dalam
output sebagai parameter berasingan.

Untuk pilihan yang panjang, '--' dan nama pilihan penuh dijana sebagai satu parameter. Ini adalah
dilakukan tanpa mengira sama ada pilihan itu dipendekkan atau ditentukan dengan satu '-' di dalam
input. Hujah dikendalikan seperti dengan pilihan pendek.

Biasanya, tiada output parameter bukan pilihan dijana sehingga semua pilihan dan pilihannya
hujah telah dihasilkan. Kemudian '--' dijana sebagai parameter tunggal, dan selepas itu
parameter bukan pilihan dalam susunan ia ditemui, setiap satu sebagai parameter berasingan.
Hanya jika aksara pertama rentetan pilihan pendek ialah '-', parameter bukan pilihan
output dijana di tempat ia ditemui dalam input (ini tidak disokong jika fail
format pertama SINOPSIS digunakan; dalam kes itu semua kejadian sebelumnya '-'dan
'+' diabaikan).

SEBUTHARGA

Dalam mod serasi, ruang kosong atau aksara 'khas' dalam hujah atau bukan pilihan
parameter tidak dikendalikan dengan betul. Memandangkan output dimasukkan ke skrip shell, the
skrip tidak tahu bagaimana ia sepatutnya memecahkan output kepada parameter berasingan. Kepada
memintas masalah ini, pelaksanaan ini menawarkan sebut harga. Ideanya ialah output adalah
dijana dengan petikan di sekitar setiap parameter. Apabila output ini sekali lagi disalurkan kepada
cangkerang (biasanya oleh cangkerang menipu arahan), ia dibahagikan dengan betul kepada parameter berasingan.

Petikan tidak didayakan jika pembolehubah persekitaran GETOPT_COMPATIBLE ditetapkan, jika yang pertama
bentuk SINOPSIS digunakan, atau jika pilihan '-u' ditemui.

Cengkerang yang berbeza menggunakan konvensyen petikan yang berbeza. Anda boleh menggunakan '-s' pilihan untuk dipilih
cangkerang yang anda gunakan. Cangkerang berikut kini disokong: 'sh','menampar',
'csh'Dan'tcsh'. Sebenarnya, hanya dua 'rasa' yang dibezakan: petikan seperti sh
konvensyen dan konvensyen memetik seperti csh. Kemungkinannya ialah jika anda menggunakan cangkerang lain
bahasa skrip, salah satu perisa ini masih boleh digunakan.

PEMARKAHAN MODUL

Aksara pertama rentetan pilihan pendek mungkin '-' atau '+' untuk menunjukkan a
mod pengimbasan khas. Jika borang panggilan pertama dalam SINOPSIS digunakan mereka adalah
diabaikan; pembolehubah persekitaran POSIXLY_BETUL masih diperiksa, walaupun.

Jika watak pertama ialah '+', atau jika pembolehubah persekitaran POSIXLY_BETUL ditetapkan,
penghuraian berhenti sebaik sahaja parameter bukan pilihan pertama (iaitu parameter yang tidak
mulakan dengan '-') didapati itu bukan hujah pilihan. Parameter selebihnya ialah
semua ditafsirkan sebagai parameter bukan pilihan.

Jika watak pertama ialah '-', parameter bukan pilihan dikeluarkan di tempat di mana
mereka ditemui; dalam operasi biasa, semuanya dikumpul pada akhir keluaran selepas a
'--' parameter telah dihasilkan. Perhatikan bahawa ini '--' parameter masih dijana, tetapi
ia akan sentiasa menjadi parameter terakhir dalam mod ini.

KOMPATIBILITAS

Versi getopt(1) ditulis supaya serasi yang mungkin kepada versi lain.
Biasanya anda boleh menggantikannya dengan versi ini tanpa sebarang pengubahsuaian, dan dengan
beberapa kelebihan.

Jika aksara pertama parameter pertama getopt bukan '-', getopt masuk ke
mod keserasian. Ia akan mentafsir parameter pertamanya sebagai rentetan pilihan pendek,
dan semua hujah lain akan dihuraikan. Ia masih akan melakukan shuffling parameter (iaitu semua
parameter bukan pilihan dikeluarkan pada penghujung), melainkan pembolehubah persekitaran
POSIXLY_BETUL ditetapkan.

Pembolehubah persekitaran GETOPT_COMPATIBLE angkatan getopt ke dalam mod keserasian. Tetapan
kedua-dua pembolehubah persekitaran ini dan POSIXLY_BETUL menawarkan 100% keserasian untuk
program 'sukar'. Biasanya, bagaimanapun, kedua-duanya tidak diperlukan.

Dalam mod keserasian, memimpin '-'Dan'+' aksara dalam rentetan pilihan pendek ialah
diabaikan.

PULANG BALIK KOD

getopt mengembalikan kod ralat 0 untuk penghuraian yang berjaya, 1 if getopt(3) mengembalikan ralat, 2 jika ia
tidak memahami parameternya sendiri, 3 jika ralat dalaman berlaku seperti kehabisan memori,
and 4 jika ia dipanggil dengan -T.

CONTOH

Skrip contoh untuk (ba)sh dan (t)csh disediakan dengan getopt(1) pengedaran, dan
dipasang secara pilihan /usr/share/getopt/ or /usr/share/doc/ dalam util-linux
subdirektori.

PERSEKITARAN

POSIXLY_BETUL
Pembolehubah persekitaran ini diperiksa oleh getopt(3) rutin. Jika ia ditetapkan,
penghuraian berhenti sebaik sahaja parameter ditemui yang bukan pilihan atau pilihan
hujah. Semua parameter yang tinggal juga ditafsirkan sebagai parameter bukan pilihan,
tidak kira sama ada mereka bermula dengan '-'.

GETOPT_COMPATIBLE
Angkatan getopt untuk menggunakan format panggilan pertama seperti yang dinyatakan dalam SINOPSIS.

Gunakan getopt dalam talian menggunakan perkhidmatan onworks.net