GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CHARMRC (5)

NAME

charmrc - Configuration file for Charm

CONTENTS

Description
Login Configuration
Friends-checking Configuration
General Archival Configuration
Posting Configuration
Posting And Editing Archival Options
Examples
Manual
See Also
Author

DESCRIPTION

A charmrc file is a configuration file for Charm, a client for LiveJournal and other blogging sites which support the LiveJournal protocol. It is a text file.

A charmrc file can include other charmrc files, with the following:

include FILENAME

Files are read in the order that they are specified. When that directive is used, processing of the current configuration file is stopped, the included configuration file is read and processed, and then processing on the current configuration file is resumed.

An active line in a charmrc file will have the format:

name = value

Blank lines are ignored. Lines that begin with a pound-sign (#) are comments, and are ignored. Leading spaces and tabs are ignored.

All boolean options can be on ("on", "yes", "y", "true", "t", "1" all work) or off ("off", "no", "n", "false", "f", "0").

Almost all options can be overridden interactively. Most things set in the configuration file are merely treated as a default.

LOGIN CONFIGURATION

login = username password [ site ]
  Specifies a journal user for a LiveJournal-based site. The site is an optional hostname, such as www.livejournal.com

hlogin = username MD5password [ site ]
  Like login except the password specified is an MD5 hash digest of the actual password.

atomblog = username password [ URIpath ]
  Specifies a journal user for an Atom API-based site. The URIpath is an optional URL for feed discovery, such as https://www.blogger.com/atom/

hatomblog = username MD5password [ URIpath ]
  Like atomblog except the password specified is an MD5 hash digest of the actual password.

metaweb = username password URIpath
  Specifies a journal user for a MetaWeb API-based site. The URIpath is the URL for the site’s XML-RPC MetaWeb interface, such as http://testuser.wordpress.com/xmlrpc.php

default_user = username
  Because login and hlogin and atomblog and hatomblog and metaweb may be specified multiple times, this parameter allows the user to specify which identity to use by default.

default_blog = username blogname
  Specifies a default blog to use when a blogging service such as Wordpress allows multiple blogs under a username.

journal = journalname
  By default, Charm uses the journal of the current user. However, some people post to a community or a shared journal more frequently than they do to their own journal. This option allows the user to specify that journal by default, rather than their own.

url = interface_url
  By default, Charm posts to LiveJournal. This parameter can be used to specify a different default, rather than specifying the site in login or hlogin (but this must be a full URL, not just the hostname).

FRIENDS-CHECKING CONFIGURATION

checkdelay = minutes
  Specifies the number of minutes to wait between each attempt to check whether friends have posted journal updates.

checkgroups = groups
  Specifies the friend groups to check. This is a comma-delimited list, such as "Group1,Group2,Group3".

GENERAL ARCHIVAL CONFIGURATION

archive_dir = directory
  Specifies the directory to save completed posts in.

organize = type
  Specifies how to organize the archive directory. type can be none (no subdirectories), year (subdirectories by year), or month (subdirectories by month within subdirectories by year).

POSTING CONFIGURATION

editor = program
  Use this program as the editor for posts.

pager = program
  Use this program as the pager when previewing posts.

spellchecker = program
  Use this program as the spellchecker for posts.

default_filter = program
  Use this program as the default when you choose to text-filter a post.

default_template = templatefile
  Load this template file as the default content for posts.

draft_dir = directory
  Use this directory as the place to save drafts in progress.


autodetect = boolean

Use XMMS music detection to automatically determine what music to use for a post?

autoformat = boolean
  Let the server HTML format our post, or do it ourselves?

backdate = boolean
  Backdate our post so it does not appear on friends pages?

comments = boolean
  Allow comments on this post?

noemail = boolean
  Do not email us when we receive comments on this post?

security = level
  Sets the security level, where level can be public (everyone), private (just the poster), friends (friends of the poster), or a list of friend group names separated by commas.

show_permissions = boolean
  Automatically add a header to the entry, stating the security level?

groupheader = group,text
  When adding permission headers, use text instead of the friend group name group

commpic = journal,userpic
  Sets the default userpic used when posting to a community or shared journal.

POSTING AND EDITING ARCHIVAL OPTIONS

archive = boolean
  Archive an entry automatically after it has been posted?

archive_edits = boolean
  Archive an entry automatically after it has been edited (modified on the server)?

archive_overwrite = boolean
  When archiving an edited entry, overwrite the original, or save the edit as a separate file?

archive_subdirs = boolean
  Use a separate subdirectory for each username, community, and shared journal, or put all archived posts under a single directory?

EXAMPLES

There is an example charmrc file. It can usually be found in /usr/share/doc/charm/sample.charmrc

MANUAL

There is a full manual for Charm. It can usually be found in /usr/share/doc/charm/charm.html

SEE ALSO

charm(1)

AUTHOR

Lydia Leong (evilhat@livejournal.com)
Search for    or go to Top of page |  Section 5 |  Main Index


--> CHARMRC (5) November 2004

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.