Difference between revisions of "Page Template"
(→Introduction to '''''Package Name''''') |
Weibullguy (talk | contribs) m |
||
| (15 intermediate revisions by 5 users not shown) | |||
| Line 2: | Line 2: | ||
|- | |- | ||
!Download Source: | !Download Source: | ||
| − | | | + | | URL |
|- | |- | ||
!Download Patch: | !Download Patch: | ||
| − | | | + | | URL - This should be a URL beginning with http://svn.cross-lfs.org/svn/repos/patches/. See http://patches.cross-lfs.org/patch-submitter for instructions on submitting patches for CBLFS. |
|} | |} | ||
---- | ---- | ||
| − | + | {{Package-Introduction|Brief description of the package you are enlightening us with. Try to provide a description in your own words. Add a link to the package's homepage for someone unfamiliar with the package to research further.|http://homepage/to/cool/package}} | |
| − | + | ---- | |
| + | |||
| + | '''<font style="color: green">If there is some reason you are adding a package and are unable to provide a brief description of it's functionality, please do two things. First, reconsider installing software that you have no idea what it does. Second, please use this template. It allows us to identify packages that need introductions without "hunting" through the wiki.</font>''' | ||
| + | |||
| + | {{Blank-Package-Introduction}} | ||
| + | |||
| + | '''<font style="color: green">Use this template to add notes where ever a note is appropriate.</font>''' | ||
| + | |||
| + | {{Note|ADD SOMETHING NOTEWORTHY}} | ||
== Dependencies == | == Dependencies == | ||
| + | |||
| + | '''<font style="color: green">If there are no dependencies, omit this section.</font>''' | ||
=== Required === | === Required === | ||
| − | * [[ | + | * [[Required Dependency #1]] |
| − | * [[ | + | * [[Required Dependency #2]] |
| + | |||
=== Recommended === | === Recommended === | ||
| − | * [[ | + | * [[Recommended Dependency #1]] |
| − | * [[ | + | * [[Recommended Dependency #2]] |
| + | |||
=== Optional === | === Optional === | ||
| − | * [[ | + | * [[Optional Dependency #1]] |
| − | * [[ | + | * [[Optional Dependency #2]] |
| − | == | + | === Runtime === |
| + | * [[Runtime Dependency #1]] | ||
| + | * [[Runtime Dependency #2]] | ||
| − | This is an optional section. If your package requires a user/group add this section to the page then append the table on the [[System User and Groups]] page. Below is an example. | + | == Creating the <NAME> User & Group == |
| + | |||
| + | '''<font style="color: green">This is an optional section. If your package requires a user/group add this section to the page then append the table on the [[System User and Groups]] page. Below is an example. If there is no need to create a user or group, omit this section.</font>''' | ||
groupadd -g ''[id]'' ''[name]'' && | groupadd -g ''[id]'' ''[name]'' && | ||
| Line 36: | Line 52: | ||
== Configuration Information == | == Configuration Information == | ||
| − | This section can contain options that you may want to include when configuring the package, but should be left as a choice, | + | '''<font style="color: green">This section can contain options that you may want to include when configuring the package, but should be left as a choice. However, don't just reproduce the output of ./configure --help; be judicious in your selection. If there are no configuration options that warrant discussion, omit this section.</font>''' |
| + | |||
| + | {| | ||
| + | |- | ||
| + | |''--enable-someoption:'' brief description of the non-default functionality provided by someoption. | ||
| + | |- | ||
| + | |''--disable-someotheroption:'' brief description of the default functionality removed by disabling someotheroption. | ||
| + | |- | ||
| + | |''--with-somepackage=DIR:'' | ||
| + | |} | ||
| − | -- | + | '''<font style="color: green">Generally speaking, CBLFS packages are installed in the /usr hierarchy although there are some exceptions. Even if you passed --prefix=/home/fubar/stuff/CBLFS/is/really/awesome/some/package/version/5.0/hope/this/works to the configure script, please use --prefix=/usr for the wiki. Thanks. Also, the instructions presume that the source package has been retrieved to the local machine, unpacked, and you have cd'd to the top of the source tree. Generally, we don't need those instructions unless there is something very unique about the process for the package you are adding.</font>''' |
== Non-Multilib == | == Non-Multilib == | ||
| Line 47: | Line 72: | ||
make | make | ||
| − | Install the package | + | Install the package: |
make install | make install | ||
== Multilib == | == Multilib == | ||
| − | '''''This package does not provide any libraries so only one installation is | + | |
| + | '''<font style="color: green">If appropriate, add this line and only include the 64-bit instructions:</font>''' | ||
| + | |||
| + | '''''This package does not provide any libraries or other ABI-specific information so only one installation is required.''''' | ||
| + | |||
| + | '''<font style="color: green">If package documentation is not installed by the 'make install' step, only include the commands to install the documentation in the 64-bit section.</font>''' | ||
=== 32Bit === | === 32Bit === | ||
| Line 61: | Line 91: | ||
make | make | ||
| − | Install the package | + | Install the package: |
make install | make install | ||
| Line 73: | Line 103: | ||
make | make | ||
| − | Install the package | + | Install the package: |
make install | make install | ||
| Line 85: | Line 115: | ||
make | make | ||
| − | Install the package | + | Install the package: |
make install | make install | ||
| Line 91: | Line 121: | ||
== Configuring == | == Configuring == | ||
| − | This section should contain information about the post-installation configuration of a package, bootscript(s), other files, creating directories. | + | '''<font style="color: green">This section should contain information about the post-installation configuration of a package, bootscript(s), other files, creating directories. Omit this section if there is no post-installation configuration required.</font>''' |
| − | = Contents = | + | == Contents == |
| − | + | '''<font style="color: green">You can find an application [[User:Weibullguy|here]] that can be used to make creating this table reasonably pain free.</font>''' | |
| − | + | {| style="text-align: left;" | |
| − | + | |-valign="top" | |
| − | Installed | + | !Installed Directories: |
| + | |/path/to/dir | ||
| + | |-valign="top" | ||
| + | !Installed Programs: | ||
| + | |Program 1, Program 2 | ||
| + | |-valign="top" | ||
| + | !Installed Libraries: | ||
| + | |library1.{a,so}, library2.{a,so} | ||
| + | |} | ||
=== Short Descriptions === | === Short Descriptions === | ||
| − | + | {| style="text-align: left;" | |
| + | |-valign="top" | ||
| + | !Program 1 | ||
| + | |is a program that converts pennies to dollars. | ||
| + | |-valign="top" | ||
| + | !Program 2 | ||
| + | |is a program that converts dollars to pennies. | ||
| + | |-valign="top" | ||
| + | !library1.{so,a} | ||
| + | |is a library that contains functions necessary to convert from dollars to pennies and vice versa. | ||
| + | |} | ||
| − | + | [[Category:<PUT APPROPRIATE CATEGORY HERE>]] '''<font style="color: green">See http://cblfs.cross-lfs.org/index.php/Special:Categories for a list of categories. Likely your package will fit in one of the existing categories. If not, and think long and hard about it, create a new category.''' | |
Latest revision as of 18:02, 17 July 2009
| Download Source: | URL |
|---|---|
| Download Patch: | URL - This should be a URL beginning with http://svn.cross-lfs.org/svn/repos/patches/. See http://patches.cross-lfs.org/patch-submitter for instructions on submitting patches for CBLFS. |
Contents
Introduction to Page Template
Brief description of the package you are enlightening us with. Try to provide a description in your own words. Add a link to the package's homepage for someone unfamiliar with the package to research further.
Project Homepage: http://homepage/to/cool/package
If there is some reason you are adding a package and are unable to provide a brief description of it's functionality, please do two things. First, reconsider installing software that you have no idea what it does. Second, please use this template. It allows us to identify packages that need introductions without "hunting" through the wiki.
Introduction to Page Template
Project Homepage: Unknown
Use this template to add notes where ever a note is appropriate.
Note
Dependencies
If there are no dependencies, omit this section.
Required
Recommended
Optional
Runtime
Creating the <NAME> User & Group
This is an optional section. If your package requires a user/group add this section to the page then append the table on the System User and Groups page. Below is an example. If there is no need to create a user or group, omit this section.
groupadd -g [id] [name] &&
useradd -c "[desc]" -d /dev/null \
-u [id] -g [name] -s /bin/false [name]
Configuration Information
This section can contain options that you may want to include when configuring the package, but should be left as a choice. However, don't just reproduce the output of ./configure --help; be judicious in your selection. If there are no configuration options that warrant discussion, omit this section.
| --enable-someoption: brief description of the non-default functionality provided by someoption. |
| --disable-someotheroption: brief description of the default functionality removed by disabling someotheroption. |
| --with-somepackage=DIR: |
Generally speaking, CBLFS packages are installed in the /usr hierarchy although there are some exceptions. Even if you passed --prefix=/home/fubar/stuff/CBLFS/is/really/awesome/some/package/version/5.0/hope/this/works to the configure script, please use --prefix=/usr for the wiki. Thanks. Also, the instructions presume that the source package has been retrieved to the local machine, unpacked, and you have cd'd to the top of the source tree. Generally, we don't need those instructions unless there is something very unique about the process for the package you are adding.
Non-Multilib
Compile the package:
./configure --prefix=/usr && make
Install the package:
make install
Multilib
If appropriate, add this line and only include the 64-bit instructions:
This package does not provide any libraries or other ABI-specific information so only one installation is required.
If package documentation is not installed by the 'make install' step, only include the commands to install the documentation in the 64-bit section.
32Bit
Compile the package:
CC="gcc ${BUILD32}" ./configure --prefix=/usr &&
make
Install the package:
make install
N32
Compile the package:
CC="gcc ${BUILDN32}" ./configure --prefix=/usr \
--libdir=/usr/lib32 &&
make
Install the package:
make install
64Bit
Compile the package:
CC="gcc ${BUILD64}" ./configure --prefix=/usr \
--libdir=/usr/lib64 &&
make
Install the package:
make install
Configuring
This section should contain information about the post-installation configuration of a package, bootscript(s), other files, creating directories. Omit this section if there is no post-installation configuration required.
Contents
You can find an application here that can be used to make creating this table reasonably pain free.
| Installed Directories: | /path/to/dir |
|---|---|
| Installed Programs: | Program 1, Program 2 |
| Installed Libraries: | library1.{a,so}, library2.{a,so} |
Short Descriptions
| Program 1 | is a program that converts pennies to dollars. |
|---|---|
| Program 2 | is a program that converts dollars to pennies. |
| library1.{so,a} | is a library that contains functions necessary to convert from dollars to pennies and vice versa. |
[[Category:<PUT APPROPRIATE CATEGORY HERE>]] See http://cblfs.cross-lfs.org/index.php/Special:Categories for a list of categories. Likely your package will fit in one of the existing categories. If not, and think long and hard about it, create a new category.
