ikiwiki - Trực tuyến trên đám mây

CHƯƠNG TRÌNH:

TÊN

ikiwiki - trình biên dịch wiki

SYNOPSIS

đích nguồn ikiwiki [tùy chọn]

ikiwiki --setup setupfile [tùy chọn]

MÔ TẢ

ikiwiki là một trình biên dịch wiki. Nó xây dựng các trang HTML tĩnh cho wiki, từ nguồn trong
ngôn ngữ ikiwiki/Markdown (hoặc ngôn ngữ khác) và viết nó ra đích.

Lưu ý rằng hầu hết các tùy chọn có thể được rút ngắn thành các chữ cái đơn, cờ boolean như --verbose
có thể bị phủ định bằng --no-verbose và các tùy chọn như --verbose cũng có thể được đánh vần như thế
-dài dòng.

PHƯƠNG THỨC LỰA CHỌN

Các tùy chọn này kiểm soát chế độ hoạt động của ikiwiki.

--Làm tươi
Làm mới wiki, cập nhật bất kỳ trang nào đã thay đổi. Đây là hành vi mặc định nếu không
hành động chế độ khác được chỉ định (nhưng lưu ý rằng --setup là một hành động chế độ và có
hành vi mặc định khác nhau).

- xây dựng lại
Buộc xây dựng lại tất cả các trang.

--tập tin cài đặt thiết lập
Tải các tùy chọn từ tệp thiết lập đã cho. Nếu không có hành động chế độ nào khác được chỉ định,
tạo các trình bao bọc và xây dựng lại wiki, như thể --rebuild --wrappers đã được sử dụng. Nếu như
bạn chỉ muốn xây dựng bất kỳ trang đã thay đổi nào, bạn có thể sử dụng --refresh với --setup.

--changesetup tập tin thiết lập
Đọc tệp cài đặt, thêm bất kỳ thay đổi cấu hình nào được chỉ định bởi các tùy chọn khác,
và ghi lại cấu hình mới vào tập tin cài đặt. Đồng thời cập nhật bất kỳ
trình bao bọc được cấu hình. Trong chế độ này, wiki không được xây dựng lại hoàn toàn, trừ khi bạn cũng
thêm --xây dựng lại.

Ví dụ, để kích hoạt một số plugin:

ikiwiki --changesetup ~/ikiwiki.setup --hàng hóa plugin --lịch plugin

--dumpsetup tập tin cài đặt
Khiến ikiwiki ghi vào tệp thiết lập được chỉ định, loại bỏ tệp hiện tại của nó
cấu hình.

--giấy gói
Nếu được sử dụng với --setup --refresh, điều này cũng khiến nó cập nhật mọi trình bao bọc được định cấu hình.

--dọn dẹp
Điều này giúp ikiwiki dọn dẹp bằng cách xóa mọi tệp mà nó tạo ra ở đích
thư mục, cũng như mọi trình bao bọc được định cấu hình và thư mục trạng thái .ikiwiki.
Điều này chủ yếu hữu ích nếu bạn đang chạy ikiwiki trong Makefile để xây dựng
tài liệu và muốn có một mục tiêu sạch tương ứng.

--cgi Bật chế độ CGI. Trong chế độ cgi, ikiwiki chạy dưới dạng tập lệnh cgi và hỗ trợ chỉnh sửa
trang, đăng nhập và đăng ký.

Để sử dụng ikiwiki làm chương trình CGI, bạn cần sử dụng --wrapper hoặc --setup để tạo một
vỏ bánh. Trình bao bọc nói chung sẽ cần chạy suid 6755 cho người dùng sở hữu
thư mục nguồn và đích.

--wrapper [tập tin]
Tạo một nhị phân bao bọc được mã hóa cứng để thực hiện hành động do người khác chỉ định
tùy chọn, sử dụng các tập tin đầu vào và thư mục đích được chỉ định. Tên tập tin để
việc sử dụng cho trình bao bọc là tùy chọn.

Trình bao bọc được thiết kế để phù hợp một cách an toàn và được điều hành bởi những người dùng không đáng tin cậy, như một
hook sau cam kết hoặc dưới dạng CGI.

Lưu ý rằng trình bao bọc được tạo sẽ bỏ qua tất cả tham số dòng lệnh.

- phân tách
Nếu plugin/plugin tổng hợp được bật, điều này sẽ cấu hình cuộc thăm dò ikiwiki
nguồn cấp dữ liệu và lưu bài đăng mới vào srcdir.

Lưu ý rằng để xây dựng lại các bài đăng đã tổng hợp trước đó, hãy sử dụng tùy chọn --rebuild cùng với
với cái này --rebuild cũng sẽ buộc các nguồn cấp dữ liệu phải được thăm dò ngay cả khi chúng
được thăm dò gần đây.

--kết xuất tập tin
Hiển thị một tệp duy nhất, xuất ra kết quả html. Không lưu trạng thái, vì vậy điều này
không thể được sử dụng để xây dựng toàn bộ wiki, nhưng nó rất hữu ích để xem trước một bản đã chỉnh sửa
tập tin tại dòng lệnh. Thường được sử dụng cùng với --setup để tải trong một
thiết lập của wiki:

ikiwiki --thiết lập ~/ikiwiki.setup --render foo.mdwn

--post-commit
Chạy ở chế độ sau cam kết, giống như khi được gọi bằng hook sau cam kết. Đây là
có lẽ chỉ hữu ích khi sử dụng ikiwiki với máy chủ web trên một máy chủ và một
kho lưu trữ khác, để cho phép móc nối sau cam kết thực sự của kho lưu trữ chuyển sang
máy chủ web và chạy ikiwiki theo cách thủ công để cập nhật trang web.

--phiên bản
In số phiên bản của ikiwiki.

CẤU HÌNH LỰA CHỌN

Các tùy chọn này cấu hình wiki. Lưu ý rằng plugin có thể thêm cấu hình bổ sung
những lựa chọn của riêng mình. Tất cả các tùy chọn này và nhiều tùy chọn khác cũng có thể được cấu hình bằng cách sử dụng một
tập tin cài đặt.

--tên wiki
Tên của wiki, mặc định là "wiki".

--thư mục templatedir
Chỉ định thư mục chứa các mẫu. Mặc định là
/usr/share/ikiwiki/templates hoặc vị trí khác được định cấu hình tại thời điểm xây dựng. Nếu như
templatedir đã thay đổi, các mẫu bị thiếu sẽ vẫn được tìm kiếm trong
vị trí mặc định làm dự phòng. Mẫu cũng có thể được đặt trong thư mục "templates/"
thư mục con của srcdir.

Lưu ý rằng nếu bạn chọn sao chép và sửa đổi các mẫu của ikiwiki, bạn sẽ cần phải
cẩn thận cập nhật chúng khi nâng cấp lên phiên bản mới của ikiwiki. Cũ
các phiên bản của mẫu không phải lúc nào cũng hoạt động với các phiên bản ikiwiki mới.

--underlaydir thư mục
Chỉ định thư mục được sử dụng để làm cơ sở cho thư mục nguồn. Tệp nguồn
sẽ được lấy từ đây trừ khi bị ghi đè bởi một tệp trong thư mục nguồn.
Mặc định là /usr/share/ikiwiki/basewiki hoặc vị trí khác được định cấu hình khi xây dựng
thời gian.

--chế độ bao bọc
Chỉ định một chế độ để chỉnh sửa trình bao bọc sau khi tạo nó.

--nhóm nhóm bao bọc
Chỉ định nhóm unix mà trình bao bọc sẽ thuộc sở hữu của. Điều này có thể hữu ích nếu
trình bao bọc cần phải được sở hữu bởi một nhóm không phải là nhóm mặc định. Ví dụ, nếu một
dự án có một kho lưu trữ với nhiều người cam kết có quyền truy cập được kiểm soát bởi một
nhóm, việc trình bao bọc ikiwiki chạy setgid cho nhóm đó là điều hợp lý.

--rcs=svn|git|.., --no-rcs
Bật hoặc tắt việc sử dụng rev_control_system.

Thư mục nguồn sẽ được coi là một bản sao làm việc, hoặc bản sao, hoặc bất cứ thứ gì
hệ thống kiểm soát sửa đổi mà bạn chọn sẽ sử dụng.

Ở chế độ CGI, khi bật hệ thống kiểm soát sửa đổi, các trang được chỉnh sửa qua web sẽ
được cam kết.

Không có kiểm soát sửa đổi nào được bật theo mặc định.

--svnrepo /svn/wiki
Chỉ định vị trí kho lưu trữ svn cho wiki.

--svnpath trung kế
Chỉ định đường dẫn bên trong kho lưu trữ svn của bạn, nơi đặt wiki. Cái này
mặc định là trung kế; hãy thay đổi nó nếu wiki của bạn ở một đường dẫn khác bên trong
kho. Nếu wiki của bạn được root ở đầu kho lưu trữ, hãy đặt svnpath thành "".

--rss, --norss
Nếu rss được đặt, ikiwiki sẽ mặc định tạo nguồn cấp dữ liệu RSS cho các trang nằm trong một dòng.
blog.

--cho phép
Nếu allowrss được đặt và rss không được đặt, ikiwiki sẽ không mặc định tạo RSS
nguồn cấp dữ liệu, nhưng việc đặt rss=yes trong lệnh nội tuyến có thể ghi đè mặc định này và
tạo ra một nguồn cấp dữ liệu.

--atom, --noatom
Nếu nguyên tử được đặt, ikiwiki sẽ mặc định tạo nguồn cấp dữ liệu Atom cho các trang nội tuyến
một blog.

--allowatom
Nếu allowatom được đặt và rss không được đặt, ikiwiki sẽ không mặc định tạo
Nguồn cấp dữ liệu Atom, nhưng việc đặt Atom=yes trong lệnh nội tuyến có thể ghi đè mặc định này
và tạo nguồn cấp dữ liệu.

--pingurl URL
Đặt URL này thành URL của dịch vụ XML-RPC để ping khi nguồn cấp dữ liệu RSS được cập nhật. Vì
ví dụ: để ping Technorati, hãy sử dụng URL http://rpc.technorati.com/rpc/ping

Tham số này có thể được chỉ định nhiều lần để chỉ định nhiều URL cho
ping

--URL địa chỉ
Chỉ định URL tới wiki. Đây là thông số bắt buộc trong chế độ CGI.

--cgiurl http://example.org/ikiwiki.cgi
Chỉ định URL tới trình bao bọc tập lệnh CGI ikiwiki. Yêu cầu khi xây dựng
wiki để biết các liên kết tới tập lệnh cgi sẽ được tạo.

--URL lịch sử
Chỉ định URL để liên kết đến để duyệt lịch sử trang. Trong URL, "[[file]]" là
được thay thế bằng tập tin để duyệt. Việc sử dụng ViewVC cho việc này là phổ biến.

--adminemail [email được bảo vệ]
Chỉ định địa chỉ email mà ikiwiki nên sử dụng để gửi email.

--URL khác biệt
Chỉ định URL để liên kết tới những thay đổi khác nhau đối với một trang. Trong URL,
"[[file]]" được thay thế bằng tệp để duyệt, "[[r1]]" là phiên bản cũ của
trang và "[[r2]]" là bản sửa đổi mới. Việc sử dụng ViewVC cho việc này là điều phổ biến.

--loại trừ biểu thức chính quy
Chỉ định rexexp của tệp nguồn để loại trừ khỏi quá trình xử lý. Có thể được chỉ định
nhiều lần để thêm vào danh sách loại trừ.

--bao gồm biểu thức chính quy
Chỉ định rexexp của các tệp nguồn, thông thường sẽ bị loại trừ, nhưng bạn
muốn đưa vào xử lý. Có thể được chỉ định nhiều lần để thêm vào
danh sách.

--tên người dùng quản trị
Chỉ định tên người dùng của người dùng (hoặc, nếu openid được bật, openid) có quyền
quyền hạn của một quản trị viên wiki. Hiện tại cho phép khóa bất kỳ trang nào và cấm người dùng, như
cũng như các quyền được cấp bởi các plugin đã bật (chẳng hạn như [[kiểm duyệt
nhận xét|plugin/nhận xét được kiểm duyệt]] và plugin/websetup. Có thể được chỉ định
nhiều lần cho nhiều quản trị viên.

Đối với người dùng openid, hãy chỉ định URL đầy đủ của thông tin đăng nhập, bao gồm "http://".

--tên plugin
Cho phép sử dụng plugin được chỉ định trong wiki. Lưu ý rằng tên plugin là
trường hợp nhạy cảm.

--disable-tên plugin
Vô hiệu hóa việc sử dụng một plugin. Ví dụ: "--disable-plugin htmlscrubber" để loại bỏ
với việc dọn dẹp HTML.

--libdir thư mục
Làm cho ikiwiki tìm trong thư mục được chỉ định trước, trước các vị trí thông thường
khi tải các tập tin thư viện và plugin. Ví dụ: nếu bạn đặt libdir thành
"/home/you/.ikiwiki/", bạn có thể cài đặt plugin foo.pm dưới dạng
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--thảo luận, --không thảo luận
Cho phép hoặc vô hiệu hóa việc thêm các liên kết "Thảo luận" vào tiêu đề của mỗi
trang. Các liên kết được kích hoạt theo mặc định.

--numbacklinks n
Kiểm soát số lượng liên kết ngược sẽ được hiển thị ở cuối trang. Thặng dư
liên kết ngược sẽ bị ẩn trong cửa sổ bật lên. Mặc định là 10. Đặt thành 0 để tắt tính năng này
tính năng này.

--thư mục con userdir
Tùy chọn, cho phép các liên kết tới người dùng wiki liên kết tới các trang bên trong một
thư mục con của wiki. Mặc định là liên kết đến các trang trong thư mục toplevel
của wiki.

--htmlvăn bản html
Định cấu hình tiện ích mở rộng được sử dụng cho các tệp html được tạo. Mặc định là "html".

--định dạng định dạng thời gian
Chỉ định cách hiển thị thời gian hoặc ngày. Chuỗi định dạng được chuyển tới
thời gian căng thẳng(3) chức năng.

--dài dòng, --không dài dòng
Hãy chi tiết về những gì đang được thực hiện.

--syslog, --no-syslog
Đăng nhập syslog(3).

--usedirs, --no-usedirs
Chuyển đổi việc tạo tệp đầu ra có tên page/index.html (mặc định) thay vì page.html.

--chỉ thị tiền tố, --no-chỉ thị tiền tố
Chuyển đổi cú pháp có tiền tố '!' mới cho các lệnh tiền xử lý. ikiwiki hiện tại
mặc định là --prefix-directives.

--w3mmode, --no-w3mmode
Bật w3mmode, cho phép w3m sử dụng ikiwiki làm tập lệnh CGI cục bộ mà không cần
máy chủ web.

--sslcookie
Chỉ gửi cookie qua kết nối SSL. Điều này sẽ ngăn chặn chúng bị
bị chặn. Nếu bạn bật tùy chọn này thì bạn phải chạy ít nhất phần CGI
của ikiwiki qua SSL.

--gettime, --no-gettime
Trích xuất thời gian tạo và sửa đổi cho mỗi trang mới từ bản sửa đổi
nhật ký của điều khiển. Việc này được thực hiện tự động khi xây dựng wiki lần đầu tiên,
vì vậy thông thường bạn không cần sử dụng tùy chọn này.

--set var=giá trị
Điều này cho phép thiết lập một biến cấu hình tùy ý, giống như khi nó được thiết lập
thông qua một tập tin cài đặt. Vì hầu hết các tùy chọn được sử dụng phổ biến nhất đều có thể được cấu hình bằng cách sử dụng
chuyển đổi dòng lệnh, bạn sẽ hiếm khi cần sử dụng điều này.

--set-yaml var=giá trị
Điều này giống như --set, nhưng nó cho phép thiết lập các biến cấu hình sử dụng các biến phức tạp
cấu trúc dữ liệu bằng cách chuyển vào tài liệu YAML.

VÍ DỤ

ikiwiki --setup my.setup

Xây dựng lại (lại) wiki hoàn toàn bằng cách sử dụng tệp cài đặt đã chỉ định.

ikiwiki --setup my.setup --refresh
Làm mới wiki, sử dụng cài đặt từ my.setup và tránh xây dựng lại bất kỳ trang nào
vẫn chưa thay đổi. Điều này nhanh hơn.

ikiwiki --setup my.setup --refresh --wrappers
Làm mới wiki, bao gồm cả việc tạo lại tất cả các chương trình bao bọc, nhưng không xây dựng lại
tất cả các trang. Hữu ích nếu bạn đã thay đổi nội dung nào đó trong tập tin cài đặt mà không
cần xây dựng lại wiki đầy đủ để cập nhật tất cả các trang nhưng bạn muốn thực hiện ngay lập tức
hiệu ứng.

ikiwiki --rebuild srcdir Destdir
Sử dụng srcdir làm nguồn và xây dựng HTML trong destdir mà không cần sử dụng tệp thiết lập.

ikiwiki srcdir đích
Sử dụng srcdir làm nguồn để cập nhật HTML của các trang đã thay đổi trong destdir mà không cần sử dụng
tập tin cài đặt.

MÔI TRƯỜNG

CC

Điều này kiểm soát trình biên dịch C nào được sử dụng để xây dựng trình bao bọc. Mặc định là 'cc'.

CFLAGS Điều này có thể được sử dụng để chuyển các tùy chọn tới trình biên dịch C khi xây dựng các trình bao bọc.

Sử dụng ikiwiki trực tuyến bằng dịch vụ onworks.net