ikiwiki - מקוון בענן

תָכְנִית:

שֵׁם

ikiwiki - מהדר של ויקי

תַקצִיר

יעד המקור של ikiwiki [אפשרויות]

ikiwiki --setup setupfile [אפשרויות]

תיאור

ikiwiki הוא מהדר של ויקי. הוא בונה דפי HTML סטטיים עבור ויקי, מהמקור ב-
שפת ikiwiki/Markdown (או אחרות), וכותבת אותה ליעד.

שימו לב שניתן לקצר את רוב האפשרויות לאותיות בודדות, דגלים בוליאניים כגון --verbose
ניתן לשלול עם --no-verbose, וניתן גם לאיית אפשרויות כגון --verbose
-מִלוּלִי.

MODE אפשרויות

אפשרויות אלו שולטות במצב שבו פועלת ikiwiki.

--לְרַעֲנֵן
רענן את הוויקי, עדכן את כל הדפים שהשתנו. זוהי התנהגות ברירת המחדל אם לא
מוגדרת פעולת מצב אחרת (אך שים לב ש--setup היא פעולת מצב ויש לה
התנהגות ברירת מחדל שונה).

--לִבנוֹת מִחָדָשׁ
כפה בנייה מחדש של כל הדפים.

--קובץ התקנה
טען אפשרויות מקובץ ההתקנה הנתון. אם לא צוינה פעולה אחרת במצב,
צור עטיפות ובנה מחדש את הוויקי, כאילו נעשה שימוש ב--rebuild --warrappers. אם
אתה רק רוצה לבנות דפים שהשתנו, אתה יכול להשתמש ב--refresh עם --setup.

--changesetup setupfile
קורא את קובץ ההתקנה, מוסיף כל שינויי תצורה שצוינו באפשרויות אחרות,
וכותב את התצורה החדשה בחזרה לקובץ ההתקנה. מעדכן גם כל
עטיפות מוגדרות. במצב זה, הוויקי לא נבנה מחדש במלואו, אלא אם כן גם אתה
הוסף --בנה מחדש.

דוגמה, כדי להפעיל כמה תוספים:

ikiwiki --changesetup ~/ikiwiki.setup --plugin productstuff --תוסף לוח שנה

--קובץ התקנה של dumpsetup
גורם ל-ikiwiki לכתוב לקובץ ההתקנה שצוין, ולזרוק את הנוכחי שלו
תצורה.

--עטיפות
אם נעשה בו שימוש עם --setup --refresh, זה גורם לו לעדכן גם את כל העטיפות המוגדרות.

--לְנַקוֹת
זה גורם ל-ikiwiki לנקות על ידי הסרת כל הקבצים שהיא יצרה ביעד
ספרייה, כמו גם כל עטיפה שהוגדרה, וספריית המצב .ikiwiki.
זה שימושי בעיקר אם אתה מפעיל את ikiwiki ב-Makefile לבנייה
תיעוד ורוצים יעד נקי מקביל.

--cgi הפעל מצב CGI. במצב cgi ikiwiki פועל כסקריפט cgi ותומך בעריכה
דפים, כניסה והרשמה.

כדי להשתמש ב-ikiwiki כתוכנת CGI, עליך להשתמש ב--wrapper או -setup כדי ליצור א
עֲטִיפָה. המעטפת תצטרך בדרך כלל להריץ suid 6755 למשתמש שבבעלותו
ספריות מקור ויעד.

--עטיפה [קובץ]
צור בינארי עטיפה שמקודד קשה לבצע פעולה שצוינה על ידי האחר
אפשרויות, באמצעות קבצי הקלט שצוינו וספריית היעד. שם הקובץ ל
השימוש בעטיפה הוא אופציונלי.

העטיפה נועדה להיעשות בבטחה ל-Suid ולהיות מנוהלת על ידי משתמשים לא מהימנים, בתור א
וו post-commit, או כ-CGI.

שימו לב שהמעטפת שנוצרה תתעלם מכל הפרמטרים של שורת הפקודה.

--לְקַבֵּץ
אם התוספים/פלאגין המצטבר מופעל, זה הופך את הסקר ל-ikiwiki להגדיר
הזנות ושמור פוסטים חדשים ב-srcdir.

שים לב שכדי לבנות מחדש פוסטים שנצברו בעבר, השתמש באפשרות --rebuild יחד
עם האחד הזה. בנייה מחדש גם תאלץ סקר עדכונים גם אם היו
נשאל לאחרונה.

--רנדור קובץ
מעבד קובץ בודד ומוציא את ה-html שהתקבל. לא שומר מדינה, אז זה
לא יכול לשמש לבניית קובצי ויקי שלמים, אבל זה שימושי לתצוגה מקדימה של עריכה
קובץ בשורת הפקודה. משמש בדרך כלל בשילוב עם --setup לטעינה ב-a
ההגדרה של ויקי:

ikiwiki --התקנה ~/ikiwiki.setup --render foo.mdwn

--אחרי התחייבות
הפעל במצב שלאחר התחייבות, אותו הדבר כאילו נקרא על ידי וו שלאחר התחייבות. זה
כנראה שימושי רק בעת שימוש ב-ikiwiki עם שרת אינטרנט על מארח אחד ו-a
מאגר על אחר, כדי לאפשר ל-hook האמיתי של המאגר לאחר ביצוע ssh
את שרת האינטרנט מארח ולהפעיל את ikiwiki באופן ידני כדי לעדכן את אתר האינטרנט.

--גִרְסָה
הדפס את מספר הגרסה של ikiwiki.

התצורה אפשרויות

אפשרויות אלו קובעות את הוויקי. שימו לב שתוספים יכולים להוסיף תצורה נוספת
אפשרויות משלהם. את כל האפשרויות הללו ועוד חוץ מזה ניתן להגדיר גם באמצעות a
קובץ ההתקנה.

--שם ויקי
שם הוויקי, ברירת המחדל היא "ויקי".

--templatedir dir
ציין את הספרייה שבה תבניות מאוחסנות. ברירת המחדל היא
/usr/share/ikiwiki/templates, או מיקום אחר כפי שהוגדר בזמן הבנייה. אם
ה-templatedir השתנה, עדיין יחפשו תבניות חסרות ב-
מיקום ברירת המחדל כחלופה. ניתן למקם תבניות גם ב"תבניות/"
ספריית המשנה של ה-srcdir.

שימו לב שאם תבחר להעתיק ולשנות את התבניות של ikiwiki, תצטרך לעשות זאת
הקפד לשמור אותם מעודכנים בעת שדרוג לגרסאות חדשות של ikiwiki. ישן
גרסאות של תבניות לא תמיד עובדות עם גרסאות חדשות של ikiwiki.

--underlaydir dir
ציין את הספרייה המשמשת לכיסוי ספריית המקור. קבצי מקור
יילקח מכאן אלא אם כן יעקוף קובץ בספריית המקור.
ברירת המחדל היא /usr/share/ikiwiki/basewiki או מיקום אחר כפי שהוגדר ב-build
הזמן.

--מצב wrapper
ציין מצב שאליו chmod את העטיפה לאחר יצירתו.

--קבוצת עטיפה
ציין לאיזו קבוצת יוניקס העטיפה צריכה להיות בבעלותה. זה יכול להיות שימושי אם
העטיפה צריכה להיות בבעלות קבוצה שאינה ברירת המחדל. לדוגמה, אם א
לפרויקט יש מאגר עם מספר מחויבים עם גישה נשלטת על ידי a
קבוצה, הגיוני שהעטיפות של ikiwiki יפעילו setgid לקבוצה זו.

--rcs=svn|git|.., --no-rcs
אפשר או השבת את השימוש במערכת revision_control_system.

ההנחה היא שספריית המקור היא עותק עבודה, או שיבוט, או כל דבר אחר
מערכת בקרת הגרסה שתבחר משתמשת.

במצב CGI, עם מערכת בקרת גרסאות מופעלת, דפים שנערכו דרך האינטרנט יעשו זאת
להיות מחויב.

אין בקרת גרסאות מופעלת כברירת מחדל.

--svnrepo /svn/wiki
ציין את המיקום של מאגר svn עבור הוויקי.

--svnpath trunk
ציין את הנתיב בתוך מאגר svn שלך שבו נמצא ה-wiki. זֶה
ברירת המחדל לתא המטען; שנה אותו אם הוויקי שלך נמצא בנתיב אחר בתוך ה-
מאגר. אם הוויקי שלך מושרשת בחלק העליון של המאגר, הגדר את svnpath ל-"".

--rss, --norss
אם rss מוגדר, ברירת המחדל של ikiwiki תיצור הזנות RSS עבור דפים המוטבעים ב-a
בלוג.

-- מאפשר
אם allowrss מוגדר, ו-rss לא מוגדר, ikiwiki לא ייצור RSS כברירת מחדל
הזנות, אבל הגדרת rss=yes בהנחיה המוטבעת יכולה לעקוף את ברירת המחדל הזו ו
ליצור הזנה.

--אטום, --נואטום
אם atom מוגדר, ברירת המחדל של ikiwiki תיצור הזנות Atom עבור דפים המוטבעים
בלוג.

--allowatom
אם allowatom מוגדר, ו-rss לא מוגדר, ikiwiki לא ייצור כברירת מחדל
הזנות של Atom, אבל הגדרת atom=yes בהנחיה המוטבעת יכולה לעקוף את ברירת המחדל הזו
וליצור פיד.

--pingurl כתובת אתר
הגדר זאת לכתובת ה-URL של שירות XML-RPC לפינג כאשר הזנת RSS מתעדכנת. ל
לדוגמה, כדי לבצע ping Technorati, השתמש בכתובת האתר http://rpc.technorati.com/rpc/ping

ניתן לציין פרמטר זה מספר פעמים כדי לציין יותר מכתובת אתר אחת
פינג.

--כתובת אתר
מציין את כתובת האתר לויקי. זהו פרמטר נדרש במצב CGI.

--cgiurl http://example.org/ikiwiki.cgi
מציין את כתובת האתר למעטפת הסקריפט של ikiwiki CGI. נדרש בעת בניית ה
ויקי לקישורים לסקריפט cgi שייווצר.

--historyurl כתובת אתר
מציין את כתובת ה-URL שאליה יש קישור לגלישה בהיסטוריית הדפים. בכתובת האתר, "[[קובץ]]" הוא
הוחלף בקובץ לעיון. זה נפוץ להשתמש ב-ViewVC בשביל זה.

--adminemail [מוגן בדוא"ל]
מציין את כתובת הדוא"ל שבה ikiwiki צריך להשתמש לשליחת דוא"ל.

--diffurl כתובת אתר
מציין את כתובת ה-URL לקישור עבור הבדל של שינויים בדף. בכתובת האתר,
"[[קובץ]]" מוחלף בקובץ לדפדוף, "[[r1]]" הוא הגרסה הישנה של
עמוד, ו-"[[r2]]" הוא הגרסה החדשה. זה נפוץ להשתמש ב-ViewVC בשביל זה.

--exclude regexp
מציין רקexp של קובצי מקור שיש לא לכלול בעיבוד. ניתן לציין
מספר פעמים כדי להוסיף לרשימת אי הכללה.

--include regexp
מציין רקexp של קובצי מקור, שבדרך כלל לא ייכללו, אבל אתה
רוצה לכלול בעיבוד. ניתן לציין מספר פעמים כדי להוסיף לכלול
רשימה.

--שם משתמש
מציין שם משתמש של משתמש (או, אם openid מופעל, openid) שיש לו את
סמכויות של מנהל ויקי. מאפשר כרגע נעילת כל עמוד, ואיסור על משתמשים, כמו
כמו גם סמכויות המוענקות על ידי תוספים מופעלים (כגון [[ניהול
comments|plugins/moderatedcomments]] ותוספים/הגדרות אינטרנט. ניתן לציין
מספר פעמים עבור מספר מנהלים.

עבור משתמש Openid ציין את כתובת האתר המלאה של הכניסה, כולל "http://".

--שם תוסף
מאפשר שימוש בתוסף שצוין בוויקי. שים לב ששמות הפלאגינים הם
רגיש לאותיות גדולות.

--disable-plugin name
משבית את השימוש בתוסף. לדוגמה "--disable-plugin htmlscrubber" כדי לבטל
עם חיטוי HTML.

ספריית --libdir
גורם ל-ikiwiki להסתכל קודם כל בספרייה שצוינה, לפני המיקומים הרגילים
בעת טעינת קבצי ספרייה ותוספים. לדוגמה, אם אתה מגדיר את libdir ל
"/home/you/.ikiwiki/", אתה יכול להתקין תוסף foo.pm כ
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--דיון, --אין דיון
מפעיל או משבית את הוספה של קישורי "דיון" לכותרת של כל אחד מהם
עמוד. הקישורים מופעלים כברירת מחדל.

--numbacklinks n
שולט בכמה קישורים נכנסים צריכים להיות מוצגים בתחתית העמוד. עודף
קישורים נכנסים יוסתרו בחלון קופץ. ברירת המחדל היא 10. הגדר ל-0 כדי להשבית זאת
תכונה.

--userdir subdir
באופן אופציונלי, מאפשר לקישורים למשתמשי הוויקי לקשר לדפים בתוך a
ספריית משנה של הוויקי. ברירת המחדל היא קישור לדפים בספרייה ברמה העליונה
של הוויקי.

--htmlext html
מגדיר את התוסף המשמש לקובצי HTML שנוצרו. ברירת המחדל היא "html".

-- פורמט זמן
ציין כיצד להציג את השעה או התאריך. מחרוזת הפורמט מועברת ל-
זמן אחסון(3) פונקציה.

--מילולית, --ללא מילה
היו מילוליים לגבי מה שנעשה.

--syslog, --no-syslog
היכנס אל syslog(3).

--usedirs, --no-usedirs
החלף יצירת קבצי פלט בשם page/index.html (ברירת מחדל) במקום page.html.

--prefix-directives, --no-prefix-directives
החלף תחביר חדש עם קידומת '!' עבור הנחיות מעבד מראש. ikiwiki כרגע
ברירת המחדל היא --prefix-directives.

--w3mmode, --no-w3mmode
הפעל את w3mmode, המאפשר ל-w3m להשתמש ב-ikiwiki כסקריפט CGI מקומי, ללא
שרת אינטרנט.

--sslcookie
שלח עוגיות רק דרך חיבור SSL. זה אמור למנוע מהם להיות
יורט. אם תפעיל אפשרות זו, עליך להפעיל לפחות את חלק ה-CGI
של ikiwiki על SSL.

--gettime, --no-gettime
חלץ זמני יצירה ושינוי עבור כל עמוד חדש מהגרסה
יומן הבקרה. זה נעשה באופן אוטומטי בעת בניית ויקי בפעם הראשונה,
כך שבדרך כלל אינך צריך להשתמש באפשרות זו.

--set var=value
זה מאפשר להגדיר משתנה תצורה שרירותי, זהה לו היה מוגדר
באמצעות קובץ התקנה. מכיוון שניתן להגדיר את האפשרויות הנפוצות ביותר באמצעות
מתגי שורת פקודה, לעתים רחוקות תצטרך להשתמש בזה.

--set-yaml var=value
זה כמו --set, אבל זה מאפשר להגדיר משתני תצורה המשתמשים ב-complex
מבני נתונים, על ידי העברת מסמך YAML.

דוגמאות

ikiwiki --setup my.setup

בנה (מחדש) לחלוטין את הוויקי באמצעות קובץ ההתקנה שצוין.

ikiwiki --setup my.setup --refresh
רענן את הוויקי, באמצעות הגדרות מ-my.setup, והימנע מבנייה מחדש של כל עמוד
לא השתנו. זה מהיר יותר.

ikiwiki --setup my.setup --refresh --wrappers
רענן את הוויקי, כולל יצירה מחדש של כל תוכניות המעטפת, אך אל תבנה מחדש
כל הדפים. שימושי אם שינית משהו בקובץ ההתקנה שלא
צריך לבנות מחדש ויקי מלא כדי לעדכן את כל הדפים, אבל אתה רוצה לקחת אותו מיד
השפעה.

ikiwiki --בנה מחדש את srcdir destdir
השתמש ב-srcdir כמקור ובנה HTML ב-destdir, מבלי להשתמש בקובץ התקנה.

ikiwiki srcdir destdir
השתמש ב-srcdir כמקור לעדכון HTML של דפים שהשתנו ב-destdir, מבלי להשתמש ב-a
קובץ ההתקנה.

הסביבה

CC

זה שולט באיזה מהדר C משמש לבניית עטיפות. ברירת המחדל היא 'cc'.

CFLAGS זה יכול לשמש כדי להעביר אפשרויות למהדר C בעת בניית עטיפות.

השתמש ב-ikiwiki באינטרנט באמצעות שירותי onworks.net