shithub: hell

ref: 40b380a7a4bb3ded2d29cf0a415b49660dc7c454
dir: /help.go/

View raw version
package main

import "fmt"

func helpString(configpath string) string {
	helpstring := `  Lines with no command are sent as a post.
  Most commands that take <index> will operate on the most recently interacted with status,
  if no index is passed.
  Posts with multiple arguments may accept "." to operate on recent status.
  Account commands accept index "@" to refer to your own account.
  E.g. /profile @
  Config file location: %s
  
  ctrl-j                       Enable and disable multi-line mode
                               Plan 9: ctrl-d , also toggles hold mode

  /help                        Show this help message.
  /reply <index> content       Reply to status by index.
  /like <index>                Favorite status by index.
  /unlike <index>              Unfavorite status by index.
  /thread <index>              View thread the indexed status is part of.
  /cat <index>                 Output a status with details (liker, replies, etc).
  /next [count]                Print next page (or next count pages) if page is open.
  /prev [count                 Print previous page (or the previous count pages).
  /page                        Print current page.
  /home                        Open timeline page.
  /public                      Open federated timeline page.
  /local                       Open instance local timeline page.
  /open <index>                Open indexed status in the system web browser.
  /download <index>            Download attached files/media from status.
  /view <index>                Preview status media in media viewer.
  /import <index>              Same as /view with an alternative media handler.
  /attach [file path]          Loads file for attaching to status.
                               Opens the configured graphical file picker if no path is given.
                               
  /detach                      Clears loaded but unposted attachments.
  /dm [content]                Create a status with direct visibility (e.g. a dm).
                               No arguments opens DM page
                               
  /rt <index>                  Boost a status by index.
  /parent <index>              View parent of status by index.
  /rm [index]                  Delete status by index
                               Deletes most recent post without an argument.
                               
  /mark <index>                Bookmark status by index.
  /unmark <index>              Unbookmark status.
  /account [index] [account]   View account statuses.
  /profile [index] [account]   View account profile.
  /pinned [index] [account]    View account's pinned statuses.
  /pause                       Pause the streaming timeline or unpause it.
                               Pressing enter on an empty line will also unpause.
                             
  /resume                      Explicitly unpause the timeline.
  /url <index> [url tag]       Open URL from status content.
                               If no tag is provided, will open the first url.
                               
  /play <index> [url tag]      Like /url but calls configured media player
  /fpost <index>               Add status to account's filters.
  /hrt [index] [account]       Toggle RT filtering for target.
  /ufpost <index>              Unfilter status.
  /edit <index> [content]      Set targeted status to [content].
                               Use without content argument to load post into input bar.

  /notice                      Prints unread notifications.
                               If there are none unread, opens notification page.
                          
  /read                        Mark notifications as read without displaying them.
  /stats                       Print some running stats.
  /help                        Print this message.
  /version                     Version control information.
  /bookmarks                   Open bookmarks page.
  /follow [index] [account]    Follow account by post index or name.
  /unfollow [index] [account]  Unfollow account by post index or name.
  /block [index] [account]     Block account by index or name.
  /unblock [index] [account]   Unblock account by index or name.
  /lp                          Display favorited status page.
  /reload                      Reload configuration file.
  
  Status Hints
  
  Posts may be prepended (and only prepended) with hints,
  including replies, statuses, direct messages and others.
  Hints override default behaviors.
  
  ?unlisted                    Set status visibility unlisted.
  ?public                      Set status visibility public.
  ?followers                   Set status visibility followers only.
  ?direct                      Set status visibility direct (as in direct message).
  ?subject="your subject"      Set the subject (Content Warning) to argument in quotes.
  ?sensitive                   Mark status material as sensitive.
  ?markdown                    Sets post content_type. Only for supported servers.
  ?html                        Sets post content_type. Only for supported servers.
`
	return fmt.Sprintf(helpstring, configpath)
}