Skip to content

Latest commit

 

History

History
722 lines (501 loc) · 23.3 KB

perlpodstyle.pod

File metadata and controls

722 lines (501 loc) · 23.3 KB

NAME

perlpodstyle - Perl POD ��鴻�帥�ゃ�˨�㋘�ゃ��

DESCRIPTION

�����������壔����ŝ����� UNIX ��� man �����若�吾����吾����������勌����㋜����ŝ�㋘�ゃ����í�ゃ�潟� ��冴�ャ��������Perl ��鴻�壔�ŝ����������≪�吾�ャ�若�̥����� POD �����吾����吾���������� 筝���㋜����ŝ�㋘�ゃ����í�ゃ�潟�с����� �����������勉�㋘�ゃ����í�ゃ�潟�壔����鴻�⓾�������<�������ŝ����激�с�潟�с�������� ������������緇������������с����激�鴻�����筝���勌����勖����吾����勌��莢���с��蕭���障����障�����

�����後����������������㏍�違�í����勐�������壔�������鴻�⓾�勉����㏍�違�í����ŝ����激�с�潟�����罕���˨�� (B<>���篏睡��������)紊ɱ����ц;荐���������障����� 綣���違�壩��篏�(I<>)��ц;荐���������障����� ��∽�医����壚��腟援��������篏�(I<>)��ц;荐���������障��; ��∽�違�� function() ��������☀��菴違�������翫�����Pod::Man ��������勐�☎�����茵������障����� ��ŝ����í�˨�潟�若����障����壔�潟����潟����� C<> ��ц��菴違�������障����� 篁���勉�������ャ�≪�˨����若�吾�吾�勐����с�� manpage(section) ��障���� L<manpage(section)> ��勐就綣���ц��菴違����������� Pod::Man �����ɱ�������̹�ï�������後�頥㊤�������障����� 2 ��ɾ�勉�勐就綣���� L<> ��с��POD �����í�若�������帥���櫝�純�с������� ��������ャ�≪�˨����若�吾�吾�勉�ŝ�潟�壔��篏������������������̬��羆���������������˩戎�����������障����� 箴�紊���������⓾����≪�吾�ャ�若�������吾�������с�������翫�������í�勉�祉�壔�激�с�潟�˨�≪�吾�ャ�若�������吾�� ��˨�障��������������腆冴�с�ŝ��������������絽吾�壔�祉�壔�激�с�潟�������ャ����障��; 篁c�������˨�≪�吾�ャ�若�������с�˨�� L<Module::Name> ���篏帥�c�⓾��������������

篁���勉����㏍�違�í�������∽�違�吾�勐����с�壔�����絽吾��man �����若�後����с�勐就綣���ц����������障����勉�с�� ��壔�㏍�鴻�ŝ����<�㋘�潟�鴻����若�˨�壔�⓾�若�吟�˨�ŝ�潟�壔�ŝ�í�����箴������������������с����障����� ��������������������壔�������������勐櫝�醇�с����������障����勉�с�������若�壔�≪��������紊���������〠����吾�� 箙演����˨�ŝ����ŝ�����������羈���������⓾�������������� man �����若�後����с�������〠��箴���������⓾����ŝ��篁���勉����㏍�違�í����吾�勐����с�壔��B<>�� ��蚊��綽�荀������������障�����

��<�吾�c�若����������� =head1 ���腓阪�����篏睡�������☀┃絎�������綽�荀������������� 罩翫兏����˨�壔�������ŝ��薊������鴻����������☗ぇ���絖����綵√����ф�吾�������⓾����障��; ��������壠�������с�壔�������障�������������祉�壔�激�с�潟����違�ŝ����純�������⓾�с�≪�������宴�若�檎���� 筝�莢˨�������������������ゃ��������綣激�������с�������障����� �����ゃ����若����������� =head2 ���篏睡�������☗�˨����������������с����� ���絽吾�壠ぇ���絖����絨����絖����羞桁�������⓾����障�����

��������ャ�≪�˨����若�吾�勖��羣���祉�壔�激�с�潟�壩❶��勉����������с��:

NAME

綽������祉�壔�激�с��: 罨<�勉�������˨�������� POD �����若�吾�ф����後����������⓾����������㏍�違�í�������障����壩����純�� ��潟�潟����у�阪����c����ŝ�鴻����˨����障��:

foo, bar - programs to do something

��������ャ�≪�˨����若�吾�ゃ�潟����壔�泣�壔����勉�祉�壔�激�с�潟�勐就綣���̹��絽吾�˨�������������������� 紊������勉�с�������勤��篁ュ����˩�������ャ����ŝ����с�������������� ������ POD �����若�吾�ф����後����������⓾����������鴻�⓾�勉����㏍�違�í�������∽�違�壔�� ��潟�潟�������鴻����若�鴻�у�阪����c�☗�����������綽�荀������������障����� Perl ��≪�吾�ャ�若�˨�勐�翫����壔����≪�吾�ャ�若�����������絎������⓾�������������� �����㏍�違�í�������∽�違�勉�ŝ�鴻�����茯㋛�������阪�������勉�壔��筝���ゃ�������勉�������激�ャ�с����� �����勤����˨�壔��C<> ��� B<> ��ŝ�í�勉����若�壔�≪�������� 篏睡�������ŝ����с�������������� ��∽�違�� () ��ŝ�í�т信蕋障����ŝ����с�������������� man �����㏍�違�í�������������激�ャ����������ゃ����勉�帥����х舟��������������������⓾����� 茯㋛����夌����括����˨�� 1 茵���������障����������˨����⓾��������������

SYNOPSIS

�����㏍�違�í����◒�∽�違�勛亜�����ŭ戎�����号����勤��膣���с����� �����勉�祉�壔�激�с�潟�壔�祉�壔�激�с�� 3 �����若�吾�с�壠�������с����� Perl ��≪�吾�ャ�若�˨�勖����吾�с�壔�������勉�祉�壔�激�с�潟�勐��絎鴻����� ��≪�吾�ャ�若�˨�勐�後�������ŭ戎�����号�����(膂≦�����)箴����腓冴�����茯������ŝ����㏍����壔�˨����⓾������� 箴水�í�с�����

DESCRIPTION

�����㏍�違�í�������∽�違�勤¼膣違�ʃą������茯㋛���������������� 篁���勉�������ャ�≪�˨����若�吾�勉�������ャ�≪�˨�勖�㋛����� ��鴻�̹�激����翫����壔��篁ヤ����勉�������˨�泣����祉�壔�激�с�� =head2 ���腓阪���� �����蚊����������������с����障��:

=head2 Normal Usage

=head2 Advanced Features

=head2 Writing Configuration Files

�����勖����吾�̹�í����������勉�с�������遺����с��罕������障��������

��≪�吾�ャ�若�˨�勐�翫�������≪�吾�ャ�若�˨�˨����c�〠��箴������������ゃ�潟�帥�若����с�ゃ�鴻�勖����吾�壔�� ���絽吾����ゃ�潟�帥�若����с�ゃ�鴻�������� =item �����˨����ŝ�鴻����勐就綣���с�� ��������̥舟��������障����� ��ゃ�潟�帥�若����с�ゃ�鴻�勖�違��綽������⓾�������吾�������ャ�� METHODS ��祉�壔�激�с�潟�� FUNCTIONS ��祉�壔�激�с�潟��CLASS METHODS ��祉�壔�激�с�潟����障���� INSTANCE METHODS ��祉�壔�激�с�潟�̹��臀勉����� 网�荀����茯㋛����������������� DESCRIPTION ��祉�壔�激�с�潟��篆�絖������障�����

OPTIONS

�����㏍�違�í����˨����c�☖戎�����������������潟����潟����í�ゃ�潟�ŝ����激�с�潟�勤¼膣違�ʃą�����с����� ��������壔��Pod::Usage ��勉�������ŝ����若�泣��篏睡����������������勤ą�������� ��ャ�˨�����綽�荀������������障����� ��������奝��絽吾����ŝ�鴻����������☀;腓冴�������������ŝ����激�с�潟�壠����ャ�� =item �������� 腓冴�������障����� ��劫����勉�ŝ����激�с�恰��絖������� B<> ��у�蚊��綽�荀������������障����� ��ŝ����激�с�潟����������ゃ�� I<> ��у�蚊��綽�荀������������障����� �����������違����ŝ����激�с�� --section=manext ��勉�祉�壔�激�с�潟�壔��罨<�勉������� 荐�菴違�������障�����

=item B<--section>=I<manext>

���臂ò����ŝ����激�с��(��激�с�若��綵√�������㏍�潟�医就綣���勌検���)��壔�������� =item 茵��� ��潟�潟�������鴻����若�鴻�у�阪����������⓾�������������ŝ����激�с�潟� 罩h�������吾�勐����с����宴�̥�㋝�ŝ�勰����勉�������⓾�ŝ�鴻����������⓾����障����� �����������違��--section ��� -s ��◑��菴違����������������с�������������� 筝���勐����壩❶��勉�������˨�ŝ����障�����

=item B<-s> I<manext>, B<--section>=I<manext>

��㏍����ŝ����激�с�潟�虁˛��帥����������勉�с�������������吾����������������с�������障����� ��激����ŝ����激�с�潟�壔����˨�������勉��綣������勉����������ʒ�激����с����������������ŝ������� ��㏍����ŝ����激�с�潟�虁��荀������ŝ����ゃ�冴�уけ����������櫝�醇�с����������障�����

RETURN VALUE

��������������翫����勉����㏍�違�í����障����奝�∽�違�勖�祉����ゃ�� 罩g∈��ɾ��篋���潟�若��������荀���с�ŝ�������㏍�違�í����с�壔�������勉�祉�壔�激�с�潟�夌����ャ�с����障��; ��������������������������翫����� 0 ���菴�������紊掩����������翫����� 0 篁ュ�����菴�������������罔�羣���с����� �����勉�祉�壔�激�с�潟�壔����∽�違��絲障����⓾�壠幻���絖����������綽�荀������������障����� ��≪�吾�ャ�若�˨�勐�翫����壔����������с�≪�吾�ャ�若�˨�ゃ�潟�帥�若����с�ゃ�鴻������� ��祉����ゃ��荀�膣����������箴水�í�с����� ��障����壔����≪�吾�ャ�若�˨�����箴������������∽�違�障����壔�<�純�������勖����吾�ф�祉����ゃ�� �����ャ�̬ą������������箴水�í�с�����

ERRORS

箴�紊���������í�若�ŝ�帥�若�潟�潟�若�����腟�篋���鴻����若�帥�鴻����������� errno ��勤┃絎���� ���絽吾����∽�違�障����壔�≪�吾�ャ�若�˨�勖����吾�˩戎�����������障����� �����㏍�違�í����勖����吾�с�壔��篁c�������� DIAGNOSTICS ���篏睡����������障����� 筝���㋜����ɾ��薑������с�壔��STDOUT ��障����� STDERR �����阪����������������潟����⓾�若�九������� �����í�若�� DIAGNOSTICS ��̬����蚊�������障����������若�喝�冴����������㏍�違�í�����������羝<�������� 篁���勉����㏍�違�í����������勉����í�若�� ERRORS ��̬����蚊�������障����� errno ���荐㊤����������∽�違�������後����������翫����壔���櫝�純�� errno ��ゃ�勐�������ŝ�ŝ�鴻����� ��������̥ず���綽�荀������������障�����

DIAGNOSTICS

�����㏍�違�í�������阪���������櫝�醇�с�勉����������鴻�⓾�勉�<����祉�若�吾�������勖����潟�� Perl ��勖����吾�������������吾�鴻�帥�ゃ�˨��緇������������������с�������障��; 荅括完��� perldiag(1) ��������с����⓾�����������(POD ��純�若�鴻�������с����⓾�����������)���

荅峨����������翫����壔����⓾�若�吟�������í�若��篆勖③��������������˩����������鴻�������˨�ゃ����⓾� 荅括完�����˨����⓾�����������; ��⓾�若�吟����ュ�������������<�勉�泣�ゃ�冴��紜���������号���������������� (�����������壠����ŝ�����������������筝��櫝�純�с��������������篌����������) "��ュ�������������<��絨�������������"��������������í�若��荐���蚊������������� �����障����������с�壔�������障��������

EXAMPLES

�����㏍�違�í����障����奝�∽�違�勌戎���箴������������ゃ����������⓾�������������� ��������������<����ŝ����с�����������; ��⓾�若�吟�壔����違����違�������������吾�勌賢��ф�����綵鴻�̥����ら�������с�������◐�ャ����������˨�ŝ����障����� 箴���壚����㋜����˨����勉�障�障�ʋ侊��純�������☖�������������⓾����障�����

箴����篏����������������茯㋛����������������˩�����腓冴����ŝ����с�������������� 箴����篏����������������茯㋛����������㏍��罧笈�純��菴遵����������������с�� 箴���勌勝��ゃ��紊у����̹�������������������с����障�����

ENVIRONMENT

�����㏍�違�í����������勉�������医��紊����; ���絽吾��=over���=item������������ =back ��� 篏睡�������⓾�ŝ�鴻����������☀;腓冴�������障����� 罨<�˩�����腓冴����障�����

=over 6

=item HOME

Used to determine the user's home directory.  F<.foorc> in this
directory is read for configuration details, if it exists.

=back

��医��紊���違�奝��絽吾����鴻�☗ぇ���絖���ŝ�勉�с����劫�ャ�ʋ�後�頥㊤�����菴遵�������� 綽�荀���壔�������障�����; �����勉�障�障�у�������勛����c�⓾����障�����

FILES

�����㏍�違�í����障����奝�∽�違�˨����c�☖戎�����������������鴻�⓾�勉����<�ゃ� (���絽吾�壔�ŝ�鴻����������☀;腓冴�������障��)��������勌戎��◐�勛����� �����<�ゃ�������� F<> ��у�蚊��綽�荀������������障����� 紊���眼���������櫝�醇�с�勉����������<�ゃ�˨�������後����������������夌�鴻�̹��荀���с�����

CAVEATS

WARNINGS �����若�違�������������������������劫�ャ�ʋ絵������綽�荀���ŝ����勉��

BUGS

紕������⓾����������勉�������������壩③���������篏������ŝ�������勉��

RESTRICTIONS

篆勖③������篋�絎���勉�ŝ�������違�� :-)

NOTES

�����勌����勖絵������

AUTHOR

茯違����吾�������勉��(茲���違�勌査���絲障����⓾�� AUTHORS ���篏睡�������⓾�����������)��� ��⓾�若�吟����g機��с�������������˨���憜����勰�糸����<�若�˨�≪����㋘� (��障����壔����違�㋘����若����勰��篆≦�������ŝ����糸����<�若�˨�≪����㋘��) ��障����壔����勌����勰�g機��������宴����˨�������������������с�������障����� �����㏍�違�í����勖����吾�壚����潟����������壔�������̹�激����������˨�������c� ��㋞�������������上��������������������荀������⓾�������⓾�� ��激�靛�����櫝�醇�с�勰�������g機��号�������御�������⓾��������������

HISTORY

篁���勉�純�若�鴻�����羇丞�������������㏍�違�í����壔����勰����勉����������翫�������������障����� ���������紊���眼�㏍�違��篆�絖������⓾�����篋冴�������障�����������絽吾�奝�激����ŝ����� ��ャ�勉����<�ゃ�˨�˩��絖���������鴻����������с�����������

���篏�罔í�˨�ゃ����⓾��

Copyright YEAR(s) YOUR NAME(s)

(������������(C)��壚��荀���с����� ������������"all rights reserved" ��壚��荀���с����� )

��í�ゃ�祉�潟�鴻��篁���������������勖�����膂≦����ʋ�号����壔��Perl ��ŭ���� ��������í�ゃ�祉�潟�鴻��篏睡����������������с��:

This library is free software; you may redistribute it and/or
modify it under the same terms as Perl itself.

��������˨�������������������勉�≪�吾�ャ�若�˨�� Perl ��х亜�����˩戎�����с�������������˨�ŝ����障����� �����勉�í�ゃ�祉�潟�鴻�勌����壩ィ��⓾�с��荀�篁吟�с����ŝ�����������羈���������⓾�����������; �����<����������í�勉�������ŝ�í�ゃ�祉�潟�鴻�с����ɾ�宴�̹�御����с����障�����

SEE ALSO

man(1)���man(7)���makewhatis(8)���catman(8)��ŝ�í�勉�� �����с����壔�������鴻�������勌����� man �����若�吾�� ���絽吾��man�����若�吾����潟�潟����у�阪����c�����膣���ŝ�ŝ�鴻�������� �����������勉�勐��������腓冴��罧笈�純�с����� man �����若�後����с�壔��罔�羣���� name(section) 綵√�����篏睡�������⓾�������翫����壔�� L<>��у�蚊��綽�荀���壔�������障��������(�ィ絅���������⓾����障��)��� �����勉�祉�壔�激�с�潟�勌����勰����勉�奝�ï����ɱ�翫�������˨�����綽�荀������������障�����

��������宴�若�吾�˨�<�若�ŝ�潟�違�ŝ�鴻�������������翫����壔����������� URL ��障���� 莖取˛�����������˨����⓾��������������

��������宴�若�吾�� Web ��泣�ゃ�������������翫����壔����������� URL ���菴遵�������障�����

��ŝ����吾�с�壔����������í�ゃ����í�ŝ�障����壔�≪�吾�ャ�若�˨�勖����吾�с�壔�� CONSTRUCTORS ��祉�壔�激�с�潟�� METHODS ��祉�壔�激�с�潟����障���� CLASS METHODS ��祉�壔�激�с�潟�� INSTANCE METHODS ��祉�壔�激�с�潟��篏睡������� ��í�ゃ����í�ŝ�勐�������勤¼膣違�ʋ����吾��篏����������网�荀����茯㋛���������������� DESCRIPTION ��祉�壔�激�с�潟��篆�絖�������綽�荀������������翫�������������障����� ��∽�違�ゃ�潟�帥����с�若�鴻�������ゅぇ荀閞<�ŝ�≪�吾�ャ�若�˨�с��������罕���勛����宴� FUNCTIONS ���篏睡��������綽�荀������������翫�������������障����� ���絽吾�̹�激����翫����壔��茯㋛�����荀�膣���������������� OVERVIEW ���篏睡��������篋冴�������障�����

��祉�壔�激�с�潟�勰��綺���壩�������с��������NAME ��壠幻�����������勉�祉�壔�激�с�潟�с�ŝ�������違�ŝ����� (��������с�ŝ�������������ゃ����� man �����若�吾�激�鴻��������紕������⓾����障����障��)��� NAME���SYNOPSIS���DESCRIPTION���OPTIONS��壚����㋘��絽吾����������˨���������������� �����勰��綺���х憗����障����� 筝���㋘�˨��SEE ALSO���AUTHOR�����������喝��罕���勤�������壩��緇����罧������⓾�������鴻����с����� ��激�鴻�������˨����c�⓾�壔��WARNINGS ��� NOTES ������緇���̥Щ��������������������������障����� 筝�荐���勰��綺���壔����祉�������í�勛�勛�����絲障����☗Ε綵���ŝ����勉�с�ŝ�������違�ŝ����障��������

��激�鴻�������˨����c�⓾�壔����∫�c�����罔�羣���吾�勰�ï����с��腓冴����������� CONFORMING TO ���篏睡�������� ��鴻�㋘����������������������㏍�違�í�������激�違����˨����潟����í�т戎����������������� 絎������с��腓冴����������� MT-LEVEL ���篏睡�������障����� �����������勤����冴����壚源��˨��C ��í�ゃ����í�ŝ�勌�������������後����������翫�����綵合����<�障�����

���緇���˨��筝���㋜����ʋ絵�����鴻�������⓾�������違�ʒ����勉����若�壔�≪�������� 篏睡�������ŝ����������˨����⓾�������������� ��������� Pod::Man ��цą�����������⓾�������������˨��Perl ��勐����違����∽�医�����man �����若� �����с�ŝ�í�������若�壔�≪�������ц��蕋障�������ŝ����障�障�˨����⓾�������������壠�������с�������� POD �����í�潟�鴻�㋘�若�帥��������������茹c����⓾�������障����� ��������˨��������緇���ф����吾��膩◒����������勉�������c�◐亜�����˨�ŝ����障����� 紊������勖�√����勉����í�潟�鴻�㋘�若�帥�壔��L<> ��˨�í�������������� ��糸����<�若�˨�≪����㋘�鴻��絲障����☁�������c�����篏����茵�������������羈���������⓾�����������; �����������c�⓾�������勉�������ʋ��篏���虁�������ŝ����с��������������

SEE ALSO

���篏睡����勉�激�鴻�������с�����罩g∈��ʃ申��������宴�˨�ゃ����⓾�壔�� ��激�鴻�������������ャ�≪�˨�祉�壔�激�с�潟�勛�ɱ垬�����荀�������綽������ man(5) ��障����� man(7) ��������с����⓾��������������

�����勖����吾�� podlators �����c�鴻����ŝ����ャ�若�激�с�潟�勌�������������☎�∞����������⓾����障����� �����違����若�吾�с�潟�壠幻��� <http://www.eyrie.org/~eagle/software/podlators/> �� Web ��泣�ゃ����������ユ����с����障�����

AUTHOR

Russ Allbery <rra@cpan.org>; �����勖����吾�勐ぇ��������壔��Larry Wall and Tom Christiansen ��˨�������ŝ�ŝ�吾����˨� pod2man 絎�茖���勖����吾�����綣������������⓾����障�����

COPYRIGHT AND LICENSE

Copyright 1999, 2000, 2001, 2004, 2006, 2008, 2010, 2015 Russ Allbery <rra@cpan.org>

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 50:

Unterminated C<C<...>> sequence