haddock - ອອນໄລນ໌ຢູ່ໃນຄລາວ

ໂຄງການ:

NAME

haddock - ເຄື່ອງມືເອກະສານສໍາລັບລະຫັດແຫຼ່ງ Haskell annotated

ສະຫຼຸບສັງລວມ

ຫົດ [ທາງເລືອກໃນການ] ເອກະສານ...

ລາຍລະອຽດ

ຫນ້າຄູ່ມືນີ້ເອກະສານສັ້ນໆກ່ຽວກັບ ຫົດ ຄໍາສັ່ງ. ເອກະສານທີ່ກວ້າງຂວາງແມ່ນ
ມີຢູ່ໃນຮູບແບບອື່ນໆລວມທັງ DVI, PostScript ແລະ HTML; ເບິ່ງຂ້າງລຸ່ມນີ້.

ເອກະສານ ແມ່ນຊື່ໄຟລ໌ທີ່ປະກອບດ້ວຍໂມດູນແຫຼ່ງ Haskell. ໂມດູນທັງໝົດທີ່ລະບຸໄວ້ໃນ
ເສັ້ນຄໍາສັ່ງຈະຖືກປຸງແຕ່ງຮ່ວມກັນ. ເມື່ອໂມດູນຫນຶ່ງຫມາຍເຖິງຫນ່ວຍງານໃນອີກອັນຫນຶ່ງ
ໂມດູນກໍາລັງດໍາເນີນການ, ເອກະສານຈະເຊື່ອມຕໍ່ໂດຍກົງກັບຫນ່ວຍງານນັ້ນ.

ຫນ່ວຍງານທີ່ບໍ່ສາມາດຊອກຫາໄດ້, ສໍາລັບການຍົກຕົວຢ່າງເນື່ອງຈາກວ່າພວກເຂົາເຈົ້າຢູ່ໃນໂມດູນທີ່ບໍ່ໄດ້ເປັນ
ການປຸງແຕ່ງເປັນສ່ວນຫນຶ່ງຂອງ batch ໃນປັດຈຸບັນ, ພຽງແຕ່ຈະບໍ່ hyperlinked ໃນການຜະລິດ
ເອກະສານ. ຫົດ ຈະ​ປ່ອຍ​ອອກ​ຄໍາ​ເຕືອນ​ໃນ​ລາຍ​ຊື່​ຕົວ​ລະ​ບຸ​ທັງ​ຫມົດ​ທີ່​ມັນ​ບໍ່​ສາ​ມາດ​
ແກ້ໄຂ.

ໂມດູນບໍ່ຄວນຈະ recursive ເຊິ່ງກັນແລະກັນ, ເປັນ ຫົດ ບໍ່ມັກລອຍຢູ່ໃນ
ວົງ.

OPTIONS

ບັນດາໂຄງການປະຕິບັດຕາມ syntax ເສັ້ນຄໍາສັ່ງ GNU ປົກກະຕິ, ມີທາງເລືອກຍາວເລີ່ມຕົ້ນດ້ວຍສອງ
ຂີດຕໍ່ (`--'). ສະຫຼຸບຂອງທາງເລືອກແມ່ນລວມຢູ່ຂ້າງລຸ່ມນີ້. ສໍາລັບລາຍລະອຽດຄົບຖ້ວນ, ເບິ່ງ
ເອກະສານອື່ນໆ.

-o DIR, --odir=DIR
ໄດເລກະທໍລີທີ່ຈະເອົາໄຟລ໌ຜົນຜະລິດ

-i ເອກະສານ, --read-interface=ເອກະສານ
ອ່ານການໂຕ້ຕອບຈາກ ເອກະສານ.

-D ເອກະສານ, --dump-interface=ເອກະສານ
dump ການໂຕ້ຕອບສໍາລັບໂມດູນເຫຼົ່ານີ້ໃນ ເອກະສານ.

-l DIR, --lib=DIR
ສະຖານທີ່ຂອງໄຟລ໌ຊ່ວຍເຫຼືອຂອງ Haddock

-h, --html
ສ້າງເອກະສານໃນຮູບແບບ HTML. ໄຟລ໌ຈໍານວນຫນຶ່ງຈະຖືກສ້າງຂື້ນໃນ
ໄດເລກະທໍລີປະຈຸບັນ (ຫຼືໄດເລກະທໍລີທີ່ລະບຸຖ້າ -o ທາງເລືອກແມ່ນໃຫ້), ລວມທັງ
ຕໍ່ໄປນີ້:

index.html
ຫນ້າລະດັບສູງສຸດຂອງເອກະສານ: ລາຍຊື່ໂມດູນທີ່ມີຢູ່, ການນໍາໃຊ້
indentation ເພື່ອເປັນຕົວແທນຂອງລໍາດັບຊັ້ນຖ້າຫາກວ່າໂມດູນແມ່ນ hierarchical.

haddock.css
ສະໄຕລ໌ຊີດທີ່ໃຊ້ໂດຍ HTML ທີ່ສ້າງຂຶ້ນ. ຮູ້ສຶກບໍ່ເສຍຄ່າທີ່ຈະປັບປຸງແກ້ໄຂນີ້
ການ​ປ່ຽນ​ແປງ​ສີ​ຫຼື​ຮູບ​ແບບ​, ຫຼື​ແມ້​ກະ​ທັ້ງ​ລະ​ບຸ​ຮູບ​ແບບ​ຂອງ​ທ່ານ​ເອງ​ໂດຍ​ການ​ນໍາ​ໃຊ້​
--css ທາງເລືອກ.

module.html
ຫນ້າ HTML ສໍາລັບແຕ່ລະໂມດູນ.

doc-index.html, doc-index-XX.html
ດັດ​ຊະ​ນີ​, ແບ່ງ​ອອກ​ເປັນ​ສອງ (functions / constructors ແລະ​ປະ​ເພດ / classes​, ເປັນ​ຕໍ່​
Haskell namespaces) ແລະແບ່ງອອກຕື່ມອີກຕາມຕົວອັກສອນ.

-- hoogle
ຜົນຜະລິດສໍາລັບ Hoogle

--html-help=ຮູບແບບ
ຜະລິດດັດສະນີແລະຕາຕະລາງເນື້ອໃນໃນຮູບແບບ mshelp, mshelp2 ຫຼື devhelp (ກັບ -h)

--source-base=URL
ລວມເອົາການເຊື່ອມຕໍ່ກັບໄຟລ໌ຕົ້ນສະບັບໃນເອກະສານທີ່ສ້າງຂຶ້ນ, ບ່ອນທີ່ URL ແມ່ນ
URL ພື້ນຖານບ່ອນທີ່ໄຟລ໌ແຫຼ່ງສາມາດພົບໄດ້.

-s urls, --source-module=URL
ລວມເອົາການເຊື່ອມຕໍ່ກັບໄຟລ໌ຕົ້ນສະບັບໃນເອກະສານທີ່ສ້າງຂຶ້ນ, ບ່ອນທີ່ URL ແມ່ນ a
ລິ້ງແຫຼ່ງລະຫັດສຳລັບແຕ່ລະໂມດູນ (ໂດຍໃຊ້ %{FILE} ຫຼື %{MODULE} vars).

--source-entity=URL
ລວມເອົາການເຊື່ອມຕໍ່ກັບໄຟລ໌ຕົ້ນສະບັບໃນເອກະສານທີ່ສ້າງຂຶ້ນ, ບ່ອນທີ່ URL ແມ່ນ a
ລິ້ງແຫຼ່ງລະຫັດສຳລັບແຕ່ລະຫົວໜ່ວຍ (ໂດຍໃຊ້ %{FILE}, %{MODULE} ຫຼື %{NAME} vars).

--comments-base=URL
URL ສໍາລັບຄໍາຄິດຄໍາເຫັນທີ່ເຊື່ອມຕໍ່ຢູ່ໃນເນື້ອຫາແລະຫນ້າດັດສະນີ.

--comments-module=URL
URL ສໍາລັບການເຊື່ອມຕໍ່ຄໍາເຫັນສໍາລັບແຕ່ລະໂມດູນ (ໂດຍໃຊ້ %{MODULE} var).

--comments-entity=URL
URL ສໍາລັບການເຊື່ອມຕໍ່ຄໍາເຫັນສໍາລັບແຕ່ລະຫນ່ວຍງານ (ໂດຍໃຊ້ %{FILE}, %{MODULE} ຫຼື %{NAME}
vars).

--css=ເອກະສານ
ໃຊ້ CSS ເອກະສານ ແທນທີ່ຈະເປັນຮູບແບບເລີ່ມຕົ້ນທີ່ມາພ້ອມກັບ ຫົດ ສໍາລັບ HTML
ຜົນຜະລິດ. ມັນຄວນຈະລະບຸບາງຊັ້ນຮຽນ: ເບິ່ງຕາຕະລາງຮູບແບບເລີ່ມຕົ້ນສໍາລັບລາຍລະອຽດ.

-p ເອກະສານ, --prologue=ເອກະສານ
ລະບຸໄຟລ໌ທີ່ມີຂໍ້ຄວາມ prologue.

-t TITLE, --title=TITLE
ການນໍາໃຊ້ TITLE ເປັນຫົວຂໍ້ຫນ້າສໍາລັບແຕ່ລະຫນ້າໃນເອກະສານ. ນີ້ຈະ
ປົກກະຕິແລ້ວແມ່ນຊື່ຂອງຫ້ອງສະຫມຸດທີ່ຖືກບັນທຶກໄວ້.

ຫົວຂໍ້ຄວນເປັນສະຕຣິງທຳມະດາ (ບໍ່ຕ້ອງໝາຍເຖິງ!).

-k NAME, --package=NAME
ລະບຸຊື່ແພັກເກັດ (ທາງເລືອກ).

-n, --no-implicit-prelude
ຢ່າຄິດວ່າ Prelude ຖືກນໍາເຂົ້າ

-d, --debug
ເປີດໃຊ້ຜົນການດີບັກເພີ່ມເຕີມ.

-?, - ຊ່ວຍ
ສະແດງການຊ່ວຍເຫຼືອ.

-V, - ການປ່ຽນແປງ
ສະບັບສະແດງ.

-v, -- verbose
ການ​ລາຍ​ງານ​ສະ​ຖາ​ນະ​ພາບ​.

--use-contents=URL
ໃຊ້ຫນ້າເນື້ອຫາ HTML ທີ່ສ້າງແຍກຕ່າງຫາກ.

--gen-ເນື້ອໃນ
ສ້າງເນື້ອຫາ HTML ຈາກສ່ວນຕິດຕໍ່ທີ່ລະບຸ.

--use-index=URL
ໃຊ້ດັດຊະນີ HTML ທີ່ສ້າງແຍກຕ່າງຫາກ.

--gen-index
ສ້າງດັດຊະນີ HTML ຈາກສ່ວນຕິດຕໍ່ທີ່ລະບຸ.

--ignore-all-exports
ປະຕິບັດຕົວຄືກັບວ່າທຸກໂມດູນມີຄຸນສົມບັດ ignore-exports

--hide=ແບບ ຈຳ ລອງ
ປະຕິບັດຕົວຄືກັບວ່າ ແບບ ຈຳ ລອງ ມີຄຸນສົມບັດເຊື່ອງ.

--use-package=PACKAGE
ໂມດູນກໍາລັງປະມວນຜົນແມ່ນຂຶ້ນກັບ PACKAGE.

ໃຊ້ haddock ອອນໄລນ໌ໂດຍໃຊ້ບໍລິການ onworks.net